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

interface paths {
    /addon: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /addon/linkers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /addon/linkers/{linker_key}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /addon/linkers/{linker_key}/values: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /addon/linkers/{linker_key}/values/{value_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                    value_id: number;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    linker_key: string;
                    value_id: number;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
                value_id: number;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /hook_events: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            repository?: {
                                events?: {
                                    href?: (...) | (...);
                                    name?: (...) | (...);
                                };
                            };
                            workspace?: {
                                events?: {
                                    href?: (...) | (...);
                                    name?: (...) | (...);
                                };
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /hook_events/{subject_type}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    subject_type: "repository" | "workspace";
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly {
                                category?: string;
                                description?: string;
                                event?:
                                    | "issue:comment_created"
                                    | "issue:created"
                                    | "issue:updated"
                                    | "project:updated"
                                    | "pullrequest:approved"
                                    | "pullrequest:changes_request_created"
                                    | "pullrequest:changes_request_removed"
                                    | "pullrequest:comment_created"
                                    | "pullrequest:comment_deleted"
                                    | "pullrequest:comment_reopened"
                                    | "pullrequest:comment_resolved"
                                    | "pullrequest:comment_updated"
                                    | "pullrequest:created"
                                    | "pullrequest:fulfilled"
                                    | "pullrequest:push"
                                    | "pullrequest:rejected"
                                    | "pullrequest:unapproved"
                                    | "pullrequest:updated"
                                    | "repo:commit_comment_created"
                                    | "repo:commit_status_created"
                                    | "repo:commit_status_updated"
                                    | "repo:created"
                                    | "repo:deleted"
                                    | "repo:fork"
                                    | "repo:imported"
                                    | "repo:push"
                                    | "repo:transfer"
                                    | "repo:updated";
                                label?: string;
                            }[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                subject_type: "repository" | "workspace";
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /pullrequests/{selected_user}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: {
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    after?: string;
                    q?: string;
                    role?:
                        | "admin"
                        | "contributor"
                        | "member"
                        | "owner";
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: (...) | (...);
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: {
                    q?: string;
                    role?:
                        | "admin"
                        | "contributor"
                        | "member"
                        | "owner";
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: (...) | (...);
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                410: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    redirect_to?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "repository";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                clone?: readonly (...)[];
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                downloads?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                forks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                hooks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                pullrequests?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watchers?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            mainbranch?: Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            };
                            name?: string;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "repository";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                clone?: readonly (...)[];
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                downloads?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                forks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                hooks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                pullrequests?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watchers?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            mainbranch?: Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            };
                            name?: string;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "repository";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                clone?: readonly (...)[];
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                downloads?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                forks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                hooks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                pullrequests?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watchers?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            mainbranch?: Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            };
                            name?: string;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                201: {
                    content: {
                        application/json: {
                            type: "repository";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                clone?: readonly (...)[];
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                downloads?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                forks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                hooks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                pullrequests?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watchers?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            mainbranch?: Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            };
                            name?: string;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/branch-restrictions: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    kind?: string;
                    pattern?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "branchrestriction";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                branch_match_kind: (...) | (...);
                                branch_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                groups?: (...) | (...);
                                id?: (...) | (...);
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                pattern: string;
                                users?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                        value?: number;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "branchrestriction";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_match_kind: "branching_model" | "glob";
                            branch_type?:
                                | "bugfix"
                                | "feature"
                                | "hotfix"
                                | "release"
                                | "development"
                                | "production";
                            groups?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                full_slug?: ...;
                                links?: ...;
                                name?: ...;
                                owner?: ...;
                                slug?: ...;
                                workspace?: ...;
                            })[];
                            id?: number;
                            kind:
                                | "allow_auto_merge_when_builds_pass"
                                | "delete"
                                | "enforce_merge_checks"
                                | "force"
                                | "push"
                                | "require_all_comments_resolved"
                                | "require_all_dependencies_merged"
                                | "require_approvals_to_merge"
                                | "require_commits_behind"
                                | "require_default_reviewer_approvals_to_merge"
                                | "require_no_changes_requested"
                                | "require_passing_builds_to_merge"
                                | "require_review_group_approvals_to_merge"
                                | "require_tasks_to_be_completed"
                                | "reset_pullrequest_approvals_on_change"
                                | "reset_pullrequest_changes_requested_on_change"
                                | "restrict_merges"
                                | "smart_reset_pullrequest_approvals";
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            pattern: string;
                            users?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            value?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branchrestriction";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_match_kind: "branching_model" | "glob";
                            branch_type?:
                                | "bugfix"
                                | "feature"
                                | "hotfix"
                                | "release"
                                | "development"
                                | "production";
                            groups?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                full_slug?: ...;
                                links?: ...;
                                name?: ...;
                                owner?: ...;
                                slug?: ...;
                                workspace?: ...;
                            })[];
                            id?: number;
                            kind:
                                | "allow_auto_merge_when_builds_pass"
                                | "delete"
                                | "enforce_merge_checks"
                                | "force"
                                | "push"
                                | "require_all_comments_resolved"
                                | "require_all_dependencies_merged"
                                | "require_approvals_to_merge"
                                | "require_commits_behind"
                                | "require_default_reviewer_approvals_to_merge"
                                | "require_no_changes_requested"
                                | "require_passing_builds_to_merge"
                                | "require_review_group_approvals_to_merge"
                                | "require_tasks_to_be_completed"
                                | "reset_pullrequest_approvals_on_change"
                                | "reset_pullrequest_changes_requested_on_change"
                                | "restrict_merges"
                                | "smart_reset_pullrequest_approvals";
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            pattern: string;
                            users?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            value?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                        value?: number;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branchrestriction";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_match_kind: "branching_model" | "glob";
                            branch_type?:
                                | "bugfix"
                                | "feature"
                                | "hotfix"
                                | "release"
                                | "development"
                                | "production";
                            groups?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                full_slug?: ...;
                                links?: ...;
                                name?: ...;
                                owner?: ...;
                                slug?: ...;
                                workspace?: ...;
                            })[];
                            id?: number;
                            kind:
                                | "allow_auto_merge_when_builds_pass"
                                | "delete"
                                | "enforce_merge_checks"
                                | "force"
                                | "push"
                                | "require_all_comments_resolved"
                                | "require_all_dependencies_merged"
                                | "require_approvals_to_merge"
                                | "require_commits_behind"
                                | "require_default_reviewer_approvals_to_merge"
                                | "require_no_changes_requested"
                                | "require_passing_builds_to_merge"
                                | "require_review_group_approvals_to_merge"
                                | "require_tasks_to_be_completed"
                                | "reset_pullrequest_approvals_on_change"
                                | "reset_pullrequest_changes_requested_on_change"
                                | "restrict_merges"
                                | "smart_reset_pullrequest_approvals";
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            pattern: string;
                            users?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            value?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/branching-model: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branching_model";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix: string;
                            }[];
                            development?: {
                                branch?: (...) & (...) & (...);
                                name: string;
                                use_mainbranch: boolean;
                            };
                            production?: {
                                branch?: (...) & (...) & (...);
                                name: string;
                                use_mainbranch: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/branching-model/settings: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branching_model_settings";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                enabled?: (...) | (...) | (...);
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix?: (...) | (...);
                            }[];
                            development?: {
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            production?: {
                                enabled?: boolean;
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branching_model_settings";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                enabled?: (...) | (...) | (...);
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix?: (...) | (...);
                            }[];
                            development?: {
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            production?: {
                                enabled?: boolean;
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "commit";
                        } & Omit<{
                            type: "base_commit";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: (...) & (...) & (...) & (...);
                            date?: string;
                            hash?: string;
                            message?: string;
                            parents?: readonly (...)[];
                            summary?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/approve: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "participant";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            approved?: boolean;
                            participated_on?: string;
                            role?: "PARTICIPANT" | "REVIEWER";
                            state?: null | "approved" | "changes_requested";
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/comments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "commit_comment";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "commit_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        commit?: {
                            type: "commit";
                        } & Omit<{
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            author?: ...;
                            date?: ...;
                            hash?: ...;
                            message?: ...;
                            parents?: ...;
                            summary?: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            participants?: readonly (...)[];
                            repository?: (...) & (...) & (...) & (...);
                        };
                    };
                };
            };
            responses: {
                201: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "commit_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            commit?: {
                                type: "commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                participants?: (...) | (...);
                                repository?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "commit_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        commit?: {
                            type: "commit";
                        } & Omit<{
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            author?: ...;
                            date?: ...;
                            hash?: ...;
                            message?: ...;
                            parents?: ...;
                            summary?: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            participants?: readonly (...)[];
                            repository?: (...) & (...) & (...) & (...);
                        };
                    };
                };
            };
            responses: {
                201: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    commit: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    commit: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            _attributes?: readonly ("public" | "read_only")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    commit: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
            };
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    page?: number;
                    pagelen?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                202: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/reports: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "report";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                data?: (...) | (...);
                                details?: (...) | (...);
                                external_id?: (...) | (...);
                                link?: (...) | (...);
                                logo_url?: (...) | (...);
                                remote_link_enabled?: (...) | (...) | (...);
                                report_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                result?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "report";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            data?: readonly {
                                title?: (...) | (...);
                                type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                value?: (...) | (...);
                            }[];
                            details?: string;
                            external_id?: string;
                            link?: string;
                            logo_url?: string;
                            remote_link_enabled?: boolean;
                            report_type?:
                                | "BUG"
                                | "COVERAGE"
                                | "SECURITY"
                                | "TEST";
                            reporter?: string;
                            result?: "FAILED" | "PENDING" | "PASSED";
                            title?: string;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "report";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        data?: readonly {
                            title?: string;
                            type?:
                                | "BOOLEAN"
                                | "DATE"
                                | "DURATION"
                                | "LINK"
                                | "NUMBER"
                                | "PERCENTAGE"
                                | "TEXT";
                            value?: Record<(...), (...)>;
                        }[];
                        details?: string;
                        external_id?: string;
                        link?: string;
                        logo_url?: string;
                        remote_link_enabled?: boolean;
                        report_type?:
                            | "BUG"
                            | "COVERAGE"
                            | "SECURITY"
                            | "TEST";
                        reporter?: string;
                        result?: "FAILED" | "PENDING" | "PASSED";
                        title?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "report";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            data?: readonly {
                                title?: (...) | (...);
                                type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                value?: (...) | (...);
                            }[];
                            details?: string;
                            external_id?: string;
                            link?: string;
                            logo_url?: string;
                            remote_link_enabled?: boolean;
                            report_type?:
                                | "BUG"
                                | "COVERAGE"
                                | "SECURITY"
                                | "TEST";
                            reporter?: string;
                            result?: "FAILED" | "PENDING" | "PASSED";
                            title?: string;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "report_annotation";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                annotation_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                created_on?: (...) | (...);
                                details?: (...) | (...);
                                external_id?: (...) | (...);
                                line?: (...) | (...);
                                link?: (...) | (...);
                                path?: (...) | (...);
                                result?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                severity?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: readonly ({
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    })[];
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: readonly ({
                            type: "report_annotation";
                        } & Omit<Readonly<Record<(...), (...)>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                            created_on?: string;
                            details?: string;
                            external_id?: string;
                            line?: number;
                            link?: string;
                            path?: string;
                            result?:
                                | "FAILED"
                                | "PASSED"
                                | "IGNORED"
                                | "SKIPPED";
                            severity?:
                                | "CRITICAL"
                                | "HIGH"
                                | "LOW"
                                | "MEDIUM";
                            summary?: string;
                            updated_on?: string;
                            uuid?: string;
                        })[];
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    annotationId: string;
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    annotationId: string;
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "report_annotation";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                            created_on?: string;
                            details?: string;
                            external_id?: string;
                            line?: number;
                            link?: string;
                            path?: string;
                            result?:
                                | "FAILED"
                                | "PASSED"
                                | "IGNORED"
                                | "SKIPPED";
                            severity?:
                                | "CRITICAL"
                                | "HIGH"
                                | "LOW"
                                | "MEDIUM";
                            summary?: string;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    annotationId: string;
                    commit: string;
                    repo_slug: string;
                    reportId: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "report_annotation";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                            created_on?: string;
                            details?: string;
                            external_id?: string;
                            line?: number;
                            link?: string;
                            path?: string;
                            result?:
                                | "FAILED"
                                | "PASSED"
                                | "IGNORED"
                                | "SKIPPED";
                            severity?:
                                | "CRITICAL"
                                | "HIGH"
                                | "LOW"
                                | "MEDIUM";
                            summary?: string;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    refname?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "commitstatus";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                refname?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                updated_on?: (...) | (...);
                                url?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "commitstatus";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            key?: string;
                            links?: {
                                commit?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            refname?: string;
                            state?:
                                | "FAILED"
                                | "INPROGRESS"
                                | "STOPPED"
                                | "SUCCESSFUL";
                            updated_on?: string;
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    key: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "commitstatus";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            key?: string;
                            links?: {
                                commit?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            refname?: string;
                            state?:
                                | "FAILED"
                                | "INPROGRESS"
                                | "STOPPED"
                                | "SUCCESSFUL";
                            updated_on?: string;
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                key: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    key: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "commitstatus";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            key?: string;
                            links?: {
                                commit?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            refname?: string;
                            state?:
                                | "FAILED"
                                | "INPROGRESS"
                                | "STOPPED"
                                | "SUCCESSFUL";
                            updated_on?: string;
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commits: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "base_commit";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                date?: (...) | (...);
                                hash?: (...) | (...);
                                message?: (...) | (...);
                                parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                                summary?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "base_commit";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                date?: (...) | (...);
                                hash?: (...) | (...);
                                message?: (...) | (...);
                                parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                                summary?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/commits/{revision}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    revision: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "base_commit";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                date?: (...) | (...);
                                hash?: (...) | (...);
                                message?: (...) | (...);
                                parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                                summary?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    revision: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "base_commit";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                date?: (...) | (...);
                                hash?: (...) | (...);
                                message?: (...) | (...);
                                parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                                summary?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/components: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "component";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/components/{component_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    component_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "component";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                component_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/default-reviewers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    target_username: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    target_username: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "account";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    target_username: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "account";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deploy-keys: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "deploy_key";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                added_on?: (...) | (...);
                                comment?: (...) | (...);
                                key?: (...) | (...);
                                label?: (...) | (...);
                                last_used?: (...) | (...);
                                links?: (...) | (...);
                                owner?: (...) | (...);
                                repository?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deploy_key";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            added_on?: string;
                            comment?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deploy_key";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            added_on?: string;
                            comment?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deploy_key";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            added_on?: string;
                            comment?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deployments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "deployment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                environment?: (...) | (...);
                                release?: (...) | (...);
                                state?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "deployment_variable";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "deployment_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deployment_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    deployment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deployment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            environment?: {
                                type: "deployment_environment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                name?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            release?: {
                                type: "deployment_release";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                created_on?: (...) | (...);
                                name?: (...) | (...);
                                url?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?: {
                                type: "deployment_state";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/diff/{spec}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    spec: string;
                    workspace: string;
                };
                query?: {
                    binary?: boolean;
                    context?: number;
                    ignore_whitespace?: boolean;
                    merge?: boolean;
                    path?: string;
                    renames?: boolean;
                    topic?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/diffstat/{spec}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    spec: string;
                    workspace: string;
                };
                query?: {
                    ignore_whitespace?: boolean;
                    merge?: boolean;
                    path?: string;
                    renames?: boolean;
                    topic?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                lines_added?: (...) | (...);
                                lines_removed?: (...) | (...);
                                new?: (...) | (...);
                                old?: (...) | (...);
                                status?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: {
                ignore_whitespace?: boolean;
                merge?: boolean;
                path?: string;
                renames?: boolean;
                topic?: boolean;
            };
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/downloads: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                406: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/downloads/{filename}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    filename: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    filename: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                filename: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/effective-branching-model: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "effective_repo_branching_model";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix: string;
                            }[];
                            development?: {
                                branch?: (...) & (...) & (...);
                                name: string;
                                use_mainbranch: boolean;
                            };
                            production?: {
                                branch?: (...) & (...) & (...);
                                name: string;
                                use_mainbranch: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/effective-default-reviewers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                reviewer_type?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/environments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "deployment_environment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                name?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "deployment_environment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        name?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "deployment_environment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            name?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    environment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "deployment_environment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            name?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes: {
        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: {
                    environment_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                202: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    path: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    renames?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                attributes?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                commit?: (...) | (...);
                                escaped_path?: (...) | (...);
                                path?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/forks: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    role?:
                        | "admin"
                        | "contributor"
                        | "member"
                        | "owner";
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: (...) | (...);
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "repository";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                clone?: readonly (...)[];
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                downloads?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                forks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                hooks?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                pullrequests?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watchers?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            mainbranch?: Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            };
                            name?: string;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/hooks: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "webhook_subscription";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                active?: (...) | (...) | (...);
                                created_at?: (...) | (...);
                                description?: (...) | (...);
                                events?: (...) | (...);
                                secret?: (...) | (...);
                                secret_set?: (...) | (...) | (...);
                                subject?: (...) | (...);
                                subject_type?: (...) | (...) | (...);
                                url?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/hooks/{uid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "issue";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                assignee?: (...) | (...);
                                component?: (...) | (...);
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                edited_on?: (...) | (...);
                                id?: (...) | (...);
                                kind?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                milestone?: (...) | (...);
                                priority?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                repository?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                version?: (...) | (...);
                                votes?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        component?: {
                            type: "component";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: ...;
                            };
                            name?: string;
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            comments?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            vote?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            watch?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: ...;
                            };
                            name?: string;
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: ...;
                                clone?: ...;
                                commits?: ...;
                                downloads?: ...;
                                forks?: ...;
                                hooks?: ...;
                                html?: ...;
                                pullrequests?: ...;
                                self?: ...;
                                watchers?: ...;
                            };
                            mainbranch?: (...) & (...) & (...);
                            name?: string;
                            owner?: (...) & (...) & (...) & (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) & (...) & (...) & (...);
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: ...;
                            };
                            name?: string;
                        };
                        votes?: number;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "issue";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            component?: {
                                type: "component";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            content?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                vote?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watch?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            milestone?: {
                                type: "milestone";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: {
                                type: "version";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            votes?: number;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "issue";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            component?: {
                                type: "component";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            content?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                vote?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watch?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            milestone?: {
                                type: "milestone";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: {
                                type: "version";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            votes?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "issue";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            component?: {
                                type: "component";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            content?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                vote?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watch?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            milestone?: {
                                type: "milestone";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: {
                                type: "version";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            votes?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                410: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "issue";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            component?: {
                                type: "component";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            content?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                vote?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                watch?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            milestone?: {
                                type: "milestone";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: {
                                type: "version";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            votes?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "issue_attachment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    path: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    path: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                changes?: (...) | (...);
                                created_on?: (...) | (...);
                                issue?: (...) | (...);
                                links?: (...) | (...);
                                message?: (...) | (...);
                                name?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        changes?: {
                            assignee?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            component?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            content?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            kind?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            milestone?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            priority?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            state?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            title?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                            version?: {
                                new?: (...) | (...);
                                old?: (...) | (...);
                            };
                        };
                        created_on?: string;
                        issue?: {
                            type: "issue";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: (...) & (...) & (...) & (...);
                            component?: (...) & (...) & (...) & (...);
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: ...;
                                comments?: ...;
                                html?: ...;
                                self?: ...;
                                vote?: ...;
                                watch?: ...;
                            };
                            milestone?: (...) & (...) & (...) & (...);
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: (...) & (...) & (...) & (...);
                            repository?: (...) & (...) & (...) & (...);
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: (...) & (...) & (...) & (...);
                            votes?: number;
                        };
                        links?: {
                            issue?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        message?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        name?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            changes?: {
                                assignee?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                component?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                content?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                kind?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                milestone?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                priority?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                state?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                title?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                version?: {
                                    new?: ...;
                                    old?: ...;
                                };
                            };
                            created_on?: string;
                            issue?: {
                                type: "issue";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                assignee?: (...) | (...);
                                component?: (...) | (...);
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                edited_on?: (...) | (...);
                                id?: (...) | (...);
                                kind?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                milestone?: (...) | (...);
                                priority?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                repository?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                version?: (...) | (...);
                                votes?: (...) | (...);
                            };
                            links?: {
                                issue?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            message?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            name?: string;
                            type: string;
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    change_id: string;
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            changes?: {
                                assignee?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                component?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                content?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                kind?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                milestone?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                priority?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                state?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                title?: {
                                    new?: ...;
                                    old?: ...;
                                };
                                version?: {
                                    new?: ...;
                                    old?: ...;
                                };
                            };
                            created_on?: string;
                            issue?: {
                                type: "issue";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                assignee?: (...) | (...);
                                component?: (...) | (...);
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                edited_on?: (...) | (...);
                                id?: (...) | (...);
                                kind?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                milestone?: (...) | (...);
                                priority?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                repository?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                version?: (...) | (...);
                                votes?: (...) | (...);
                            };
                            links?: {
                                issue?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            message?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            name?: string;
                            type: string;
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                change_id: string;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "issue_comment";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                issue?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: (...) & (...) & (...) & (...);
                            component?: (...) & (...) & (...) & (...);
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: ...;
                                comments?: ...;
                                html?: ...;
                                self?: ...;
                                vote?: ...;
                                watch?: ...;
                            };
                            milestone?: (...) & (...) & (...) & (...);
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: (...) & (...) & (...) & (...);
                            repository?: (...) & (...) & (...) & (...);
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: (...) & (...) & (...) & (...);
                            votes?: number;
                        };
                    };
                };
            };
            responses: {
                201: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "issue_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            issue?: {
                                type: "issue";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                assignee?: (...) | (...);
                                component?: (...) | (...);
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                edited_on?: (...) | (...);
                                id?: (...) | (...);
                                kind?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                milestone?: (...) | (...);
                                priority?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                repository?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                version?: (...) | (...);
                                votes?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            assignee?: (...) & (...) & (...) & (...);
                            component?: (...) & (...) & (...) & (...);
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            edited_on?: string;
                            id?: number;
                            kind?:
                                | "task"
                                | "bug"
                                | "enhancement"
                                | "proposal";
                            links?: {
                                attachments?: ...;
                                comments?: ...;
                                html?: ...;
                                self?: ...;
                                vote?: ...;
                                watch?: ...;
                            };
                            milestone?: (...) & (...) & (...) & (...);
                            priority?:
                                | "blocker"
                                | "critical"
                                | "major"
                                | "minor"
                                | "trivial";
                            reporter?: (...) & (...) & (...) & (...);
                            repository?: (...) & (...) & (...) & (...);
                            state?:
                                | "closed"
                                | "duplicate"
                                | "invalid"
                                | "new"
                                | "on hold"
                                | "open"
                                | "resolved"
                                | "submitted"
                                | "wontfix";
                            title?: string;
                            updated_on?: string;
                            version?: (...) & (...) & (...) & (...);
                            votes?: number;
                        };
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "issue_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            issue?: {
                                type: "issue";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                assignee?: (...) | (...);
                                component?: (...) | (...);
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                edited_on?: (...) | (...);
                                id?: (...) | (...);
                                kind?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                links?: (...) | (...);
                                milestone?: (...) | (...);
                                priority?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                reporter?: (...) | (...);
                                repository?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                                version?: (...) | (...);
                                votes?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                default: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    issue_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/export: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        include_attachments?: boolean;
                        project_key?: string;
                        project_name?: string;
                        send_email?: boolean;
                        type: string;
                    };
                };
            };
            responses: {
                202: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_name: string;
                    repo_slug: string;
                    task_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                202: {
                    content: {
                        application/json: {
                            count?: number;
                            pct?: number;
                            phase?: string;
                            status?:
                                | "ACCEPTED"
                                | "FAILURE"
                                | "RUNNING"
                                | "STARTED";
                            total?: number;
                            type?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_name: string;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/issues/import: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            count?: number;
                            pct?: number;
                            phase?: string;
                            status?:
                                | "ACCEPTED"
                                | "FAILURE"
                                | "RUNNING"
                                | "STARTED";
                            total?: number;
                            type?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                202: {
                    content: {
                        application/json: {
                            count?: number;
                            pct?: number;
                            phase?: string;
                            status?:
                                | "ACCEPTED"
                                | "FAILURE"
                                | "RUNNING"
                                | "STARTED";
                            total?: number;
                            type?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                202: {
                    content: {
                        application/json: {
                            count?: number;
                            pct?: number;
                            phase?: string;
                            status?:
                                | "ACCEPTED"
                                | "FAILURE"
                                | "RUNNING"
                                | "STARTED";
                            total?: number;
                            type?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/merge-base/{revspec}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    revspec: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "commit";
                        } & Omit<{
                            type: "base_commit";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: (...) & (...) & (...) & (...);
                            date?: string;
                            hash?: string;
                            message?: string;
                            parents?: readonly (...)[];
                            summary?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revspec: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/milestones: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "milestone";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/milestones/{milestone_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    milestone_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "milestone";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                milestone_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/override-settings: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            override_settings?: Record<string, unknown>;
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/patch/{spec}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    spec: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/permissions-config/groups: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                group?: (...) | (...);
                                links?: (...) | (...);
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                repository?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            group?: {
                                type: "group";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                full_slug?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                slug?: (...) | (...);
                                workspace?: (...) | (...);
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "read"
                                | "write"
                                | "none";
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        permission: "admin" | "read" | "write";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            group?: {
                                type: "group";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                full_slug?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                slug?: (...) | (...);
                                workspace?: (...) | (...);
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "read"
                                | "write"
                                | "none";
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                402: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/permissions-config/users: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                repository?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "read"
                                | "write"
                                | "none";
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                            user?: {
                                type: "user";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                account_id?: (...) | (...);
                                account_status?: (...) | (...);
                                has_2fa_enabled?: (...) | (...) | (...);
                                is_staff?: (...) | (...) | (...);
                                links?: (...) | (...);
                                nickname?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        permission: "admin" | "read" | "write";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "read"
                                | "write"
                                | "none";
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                            user?: {
                                type: "user";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                account_id?: (...) | (...);
                                account_status?: (...) | (...);
                                has_2fa_enabled?: (...) | (...) | (...);
                                is_staff?: (...) | (...) | (...);
                                links?: (...) | (...);
                                nickname?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                402: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                build_number?: (...) | (...);
                                build_seconds_used?: (...) | (...);
                                completed_on?: (...) | (...);
                                configuration_sources?: (...) | (...);
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                links?: (...) | (...);
                                repository?: (...) | (...);
                                state?: (...) | (...);
                                target?: (...) | (...);
                                trigger?: (...) | (...);
                                uuid?: (...) | (...);
                                variables?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        build_number?: number;
                        build_seconds_used?: number;
                        completed_on?: string;
                        configuration_sources?: readonly {
                            source: string;
                            uri: string;
                        }[];
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        links?: {
                            type: "pipelines_pipeline_links";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            self?: (...) & (...) & (...) & (...);
                            steps?: (...) & (...) & (...) & (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: ...;
                                clone?: ...;
                                commits?: ...;
                                downloads?: ...;
                                forks?: ...;
                                hooks?: ...;
                                html?: ...;
                                pullrequests?: ...;
                                self?: ...;
                                watchers?: ...;
                            };
                            mainbranch?: (...) & (...) & (...);
                            name?: string;
                            owner?: (...) & (...) & (...) & (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) & (...) & (...) & (...);
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                        state?: {
                            type: "pipeline_state";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>>;
                        target?: {
                            type: "pipeline_target";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>>;
                        trigger?: {
                            type: "pipeline_trigger";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>>;
                        uuid?: string;
                        variables?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            build_number?: number;
                            build_seconds_used?: number;
                            completed_on?: string;
                            configuration_sources?: readonly {
                                source: string;
                                uri: string;
                            }[];
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            links?: {
                                type: "pipelines_pipeline_links";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                self?: (...) | (...);
                                steps?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?: {
                                type: "pipeline_state";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            target?: {
                                type: "pipeline_target";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            trigger?: {
                                type: "pipeline_trigger";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            uuid?: string;
                            variables?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                key?: ...;
                                secured?: ...;
                                uuid?: ...;
                                value?: ...;
                            })[];
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipelines_config";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            enabled?: boolean;
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipelines_config";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                        repository?: {
                            type: "repository";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                            full_name?: string;
                            has_issues?: boolean;
                            has_wiki?: boolean;
                            is_private?: boolean;
                            language?: string;
                            links?: {
                                avatar?: ...;
                                clone?: ...;
                                commits?: ...;
                                downloads?: ...;
                                forks?: ...;
                                hooks?: ...;
                                html?: ...;
                                pullrequests?: ...;
                                self?: ...;
                                watchers?: ...;
                            };
                            mainbranch?: (...) & (...) & (...);
                            name?: string;
                            owner?: (...) & (...) & (...) & (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) & (...) & (...) & (...);
                            scm?: "git";
                            size?: number;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipelines_config";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            enabled?: boolean;
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/build_number: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_build_number";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        next?: number;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_build_number";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            next?: number;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/schedules: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_schedule";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                cron_pattern?: (...) | (...);
                                enabled?: (...) | (...) | (...);
                                target?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_schedule_post_request_body";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        cron_pattern: string;
                        enabled?: boolean;
                        target: {
                            ref_name: string;
                            ref_type: "branch";
                            selector: never;
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_schedule";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            cron_pattern?: string;
                            enabled?: boolean;
                            target?: {
                                type: "pipeline_ref_target";
                            } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                ref_name?: (...) | (...);
                                ref_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                selector?: undefined;
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    schedule_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    schedule_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_schedule";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            cron_pattern?: string;
                            enabled?: boolean;
                            target?: {
                                type: "pipeline_ref_target";
                            } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                ref_name?: (...) | (...);
                                ref_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                selector?: undefined;
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    schedule_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_schedule_put_request_body";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_schedule";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            cron_pattern?: string;
                            enabled?: boolean;
                            target?: {
                                type: "pipeline_ref_target";
                            } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                ref_name?: (...) | (...);
                                ref_type?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                selector?: undefined;
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    schedule_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_schedule_execution";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_ssh_key_pair";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            private_key?: string;
                            public_key?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_ssh_key_pair";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        private_key?: string;
                        public_key?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_ssh_key_pair";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            private_key?: string;
                            public_key?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_known_host";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                hostname?: (...) | (...);
                                public_key?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            key_type?: string;
                            md5_fingerprint?: string;
                            sha256_fingerprint?: string;
                        };
                        uuid?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_known_host";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            hostname?: string;
                            public_key?: {
                                type: "pipeline_ssh_public_key";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                key_type?: (...) | (...);
                                md5_fingerprint?: (...) | (...);
                                sha256_fingerprint?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    known_host_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    known_host_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_known_host";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            hostname?: string;
                            public_key?: {
                                type: "pipeline_ssh_public_key";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                key_type?: (...) | (...);
                                md5_fingerprint?: (...) | (...);
                                sha256_fingerprint?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    known_host_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            key_type?: string;
                            md5_fingerprint?: string;
                            sha256_fingerprint?: string;
                        };
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_known_host";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            hostname?: string;
                            public_key?: {
                                type: "pipeline_ssh_public_key";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                key_type?: (...) | (...);
                                md5_fingerprint?: (...) | (...);
                                sha256_fingerprint?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/variables: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_variable";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines-config/caches: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query: {
                    name: string;
                };
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_cache";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                file_size_bytes?: (...) | (...);
                                key_hash?: (...) | (...);
                                name?: (...) | (...);
                                path?: (...) | (...);
                                pipeline_uuid?: (...) | (...);
                                step_uuid?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    cache_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<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;
    };
    /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    cache_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            uri?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            build_number?: number;
                            build_seconds_used?: number;
                            completed_on?: string;
                            configuration_sources?: readonly {
                                source: string;
                                uri: string;
                            }[];
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            links?: {
                                type: "pipelines_pipeline_links";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                self?: (...) | (...);
                                steps?: (...) | (...);
                            };
                            repository?: {
                                type: "repository";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                fork_policy?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                full_name?: (...) | (...);
                                has_issues?: (...) | (...) | (...);
                                has_wiki?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                language?: (...) | (...);
                                links?: (...) | (...);
                                mainbranch?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                project?: (...) | (...);
                                scm?: (...) | (...);
                                size?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            state?: {
                                type: "pipeline_state";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            target?: {
                                type: "pipeline_target";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            trigger?: {
                                type: "pipeline_trigger";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            uuid?: string;
                            variables?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                key?: ...;
                                secured?: ...;
                                uuid?: ...;
                                value?: ...;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_step";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                completed_on?: (...) | (...);
                                image?: (...) | (...);
                                script_commands?: (...) | (...);
                                setup_commands?: (...) | (...);
                                started_on?: (...) | (...);
                                state?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_step";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            completed_on?: string;
                            image?: {
                                email?: string;
                                name?: string;
                                password?: string;
                                username?: string;
                            };
                            script_commands?: readonly {
                                command?: (...) | (...);
                                name?: (...) | (...);
                            }[];
                            setup_commands?: readonly {
                                command?: (...) | (...);
                                name?: (...) | (...);
                            }[];
                            started_on?: string;
                            state?: {
                                type: "pipeline_step_state";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                304: {
                    content: {
                        application/octet-stream: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/octet-stream: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                416: {
                    content: {
                        application/octet-stream: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    log_uuid: string;
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/octet-stream: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    step_uuid: string;
                    test_case_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline: {
        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: {
                    pipeline_uuid: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            _attributes?: readonly ("public" | "read_only")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
            };
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pullrequest";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            close_source_branch?: boolean;
                            closed_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            id?: number;
                            links?: {
                                activity?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                approve?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                decline?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diffstat?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                merge?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            merge_commit?: {
                                hash?: string;
                            };
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            reason?: string;
                            rendered?: {
                                description?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                reason?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                title?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                            };
                            reviewers?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            source?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            close_source_branch?: boolean;
                            closed_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            id?: number;
                            links?: {
                                activity?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                approve?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                decline?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diffstat?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                merge?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            merge_commit?: {
                                hash?: string;
                            };
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            reason?: string;
                            rendered?: {
                                description?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                reason?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                title?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                            };
                            reviewers?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            source?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            close_source_branch?: boolean;
                            closed_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            id?: number;
                            links?: {
                                activity?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                approve?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                decline?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diffstat?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                merge?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            merge_commit?: {
                                hash?: string;
                            };
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            reason?: string;
                            rendered?: {
                                description?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                reason?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                title?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                            };
                            reviewers?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            source?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "participant";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            approved?: boolean;
                            participated_on?: string;
                            role?: "PARTICIPANT" | "REVIEWER";
                            state?: null | "approved" | "changes_requested";
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest_comment";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                pending?: (...) | (...) | (...);
                                pullrequest?: (...) | (...);
                                resolution?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: (...) & (...) & (...) & (...);
                            close_source_branch?: boolean;
                            closed_by?: (...) & (...) & (...) & (...);
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: ...;
                                commit?: ...;
                                repository?: ...;
                            };
                            id?: number;
                            links?: {
                                activity?: ...;
                                approve?: ...;
                                comments?: ...;
                                commits?: ...;
                                decline?: ...;
                                diff?: ...;
                                diffstat?: ...;
                                html?: ...;
                                merge?: ...;
                                self?: ...;
                            };
                            merge_commit?: {
                                hash?: ...;
                            };
                            participants?: readonly (...)[];
                            reason?: string;
                            rendered?: {
                                description?: ...;
                                reason?: ...;
                                title?: ...;
                            };
                            reviewers?: readonly (...)[];
                            source?: {
                                branch?: ...;
                                commit?: ...;
                                repository?: ...;
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                        resolution?: Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            type: string;
                            user?: (...) & (...) & (...) & (...);
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pullrequest_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            pending?: boolean;
                            pullrequest?: {
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                            resolution?: Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            pending?: boolean;
                            pullrequest?: {
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                            resolution?: Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: (...) & (...) & (...) & (...);
                            close_source_branch?: boolean;
                            closed_by?: (...) & (...) & (...) & (...);
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: ...;
                                commit?: ...;
                                repository?: ...;
                            };
                            id?: number;
                            links?: {
                                activity?: ...;
                                approve?: ...;
                                comments?: ...;
                                commits?: ...;
                                decline?: ...;
                                diff?: ...;
                                diffstat?: ...;
                                html?: ...;
                                merge?: ...;
                                self?: ...;
                            };
                            merge_commit?: {
                                hash?: ...;
                            };
                            participants?: readonly (...)[];
                            reason?: string;
                            rendered?: {
                                description?: ...;
                                reason?: ...;
                                title?: ...;
                            };
                            reviewers?: readonly (...)[];
                            source?: {
                                branch?: ...;
                                commit?: ...;
                                repository?: ...;
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                        resolution?: Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            type: string;
                            user?: (...) & (...) & (...) & (...);
                        };
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest_comment";
                        } & Omit<{
                            type: "comment";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: ...;
                                path: ...;
                                to?: ...;
                            };
                            links?: {
                                code?: ...;
                                html?: ...;
                                self?: ...;
                            };
                            parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                            updated_on?: string;
                            user?: (...) & (...) & (...) & (...);
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            pending?: boolean;
                            pullrequest?: {
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                            resolution?: Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            type: string;
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            close_source_branch?: boolean;
                            closed_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            id?: number;
                            links?: {
                                activity?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                approve?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                decline?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diffstat?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                merge?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            merge_commit?: {
                                hash?: string;
                            };
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            reason?: string;
                            rendered?: {
                                description?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                reason?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                title?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                            };
                            reviewers?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            source?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    async?: boolean;
                };
            };
            requestBody?: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        close_source_branch?: boolean;
                        merge_strategy?: "fast_forward" | "merge_commit" | "squash";
                        message?: string;
                        type: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pullrequest";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            close_source_branch?: boolean;
                            closed_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            comment_count?: number;
                            created_on?: string;
                            destination?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            id?: number;
                            links?: {
                                activity?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                approve?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                comments?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                decline?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                diffstat?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                merge?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            merge_commit?: {
                                hash?: string;
                            };
                            participants?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                approved?: ...;
                                participated_on?: ...;
                                role?: ...;
                                state?: ...;
                                user?: ...;
                            })[];
                            reason?: string;
                            rendered?: {
                                description?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                reason?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                title?: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                            };
                            reviewers?: readonly ({
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            })[];
                            source?: {
                                branch?: {
                                    default_merge_strategy?: ...;
                                    merge_strategies?: ...;
                                    name?: ...;
                                };
                                commit?: {
                                    hash?: ...;
                                };
                                repository?: (...) & (...) & (...) & (...);
                            };
                            state?:
                                | "DECLINED"
                                | "MERGED"
                                | "OPEN"
                                | "SUPERSEDED";
                            summary?: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            task_count?: number;
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                202: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    task_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "participant";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            approved?: boolean;
                            participated_on?: string;
                            role?: "PARTICIPANT" | "REVIEWER";
                            state?: null | "approved" | "changes_requested";
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "commitstatus";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                refname?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                updated_on?: (...) | (...);
                                url?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    pagelen?: number;
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                content: {
                                    html?: ...;
                                    markup?: ...;
                                    raw?: ...;
                                };
                                created_on: string;
                                creator: (...) & (...) & (...) & (...);
                                id?: (...) | (...);
                                pending?: (...) | (...) | (...);
                                resolved_by?: (...) | (...);
                                resolved_on?: (...) | (...);
                                state: (...) | (...);
                                updated_on: string;
                            } & {
                                links?: (...) | (...);
                            } & {
                                comment?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        comment?: {
                            type: "comment";
                        } & Omit<Readonly<Record<(...), (...)>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            content?: {
                                html?: (...) | (...);
                                markup?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                raw?: (...) | (...);
                            };
                            created_on?: string;
                            deleted?: boolean;
                            id?: number;
                            inline?: {
                                from?: (...) | (...);
                                path: string;
                                to?: (...) | (...);
                            };
                            links?: {
                                code?: (...) | (...);
                                html?: (...) | (...);
                                self?: (...) | (...);
                            };
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: string;
                            user?: {
                                type: ...;
                            } & Omit<(...), (...)> & Readonly<(...)> & {
                                created_on?: ...;
                                display_name?: ...;
                                links?: ...;
                                uuid?: ...;
                            };
                        };
                        content: {
                            raw: string;
                        };
                        pending?: boolean;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            content: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on: string;
                            creator: {
                                type: "account";
                            } & Omit<Readonly<(...)> & {
                                type: ...;
                            }, "type"> & Readonly<Record<string, unknown>> & {
                                created_on?: string;
                                display_name?: string;
                                links?: (...) & (...);
                                uuid?: string;
                            };
                            id?: number;
                            pending?: boolean;
                            resolved_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            resolved_on?: string;
                            state: "RESOLVED" | "UNRESOLVED";
                            updated_on: string;
                        } & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                        } & {
                            comment?: {
                                type: "comment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                deleted?: (...) | (...) | (...);
                                id?: (...) | (...);
                                inline?: (...) | (...);
                                links?: (...) | (...);
                                parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                updated_on?: (...) | (...);
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    task_id: number;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    task_id: number;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            content: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on: string;
                            creator: {
                                type: "account";
                            } & Omit<Readonly<(...)> & {
                                type: ...;
                            }, "type"> & Readonly<Record<string, unknown>> & {
                                created_on?: string;
                                display_name?: string;
                                links?: (...) & (...);
                                uuid?: string;
                            };
                            id?: number;
                            pending?: boolean;
                            resolved_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            resolved_on?: string;
                            state: "RESOLVED" | "UNRESOLVED";
                            updated_on: string;
                        } & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                        } & {
                            comment?: {
                                type: "comment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                deleted?: (...) | (...) | (...);
                                id?: (...) | (...);
                                inline?: (...) | (...);
                                links?: (...) | (...);
                                parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                updated_on?: (...) | (...);
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    pull_request_id: number;
                    repo_slug: string;
                    task_id: number;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        content?: {
                            raw: string;
                        };
                        state?: "RESOLVED" | "UNRESOLVED";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            content: {
                                html?: string;
                                markup?: "creole" | "markdown" | "plaintext";
                                raw?: string;
                            };
                            created_on: string;
                            creator: {
                                type: "account";
                            } & Omit<Readonly<(...)> & {
                                type: ...;
                            }, "type"> & Readonly<Record<string, unknown>> & {
                                created_on?: string;
                                display_name?: string;
                                links?: (...) & (...);
                                uuid?: string;
                            };
                            id?: number;
                            pending?: boolean;
                            resolved_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            resolved_on?: string;
                            state: "RESOLVED" | "UNRESOLVED";
                            updated_on: string;
                        } & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                        } & {
                            comment?: {
                                type: "comment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                content?: (...) | (...);
                                created_on?: (...) | (...);
                                deleted?: (...) | (...) | (...);
                                id?: (...) | (...);
                                inline?: (...) | (...);
                                links?: (...) | (...);
                                parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                                updated_on?: (...) | (...);
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    pullrequest_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    pullrequest_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            _attributes?: readonly ("public" | "read_only")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    pullrequest_id: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
            };
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/pullrequests/activity: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/refs: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/refs/branches: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                default_merge_strategy?: (...) | (...);
                                merge_strategies?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            target?: {
                                type: "commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                participants?: (...) | (...);
                                repository?: (...) | (...);
                            };
                            type: string;
                        } & {
                            default_merge_strategy?: string;
                            merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/refs/branches/{name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            target?: {
                                type: "commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                participants?: (...) | (...);
                                repository?: (...) | (...);
                            };
                            type: string;
                        } & {
                            default_merge_strategy?: string;
                            merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/refs/tags: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                name?: (...) | (...);
                                target?: (...) | (...);
                                type: string;
                            } & {
                                date?: (...) | (...);
                                message?: (...) | (...);
                                tagger?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<{
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            author?: ...;
                            date?: ...;
                            hash?: ...;
                            message?: ...;
                            parents?: ...;
                            summary?: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            participants?: readonly (...)[];
                            repository?: (...) & (...) & (...) & (...);
                        };
                        type: string;
                    } & {
                        date?: string;
                        message?: string;
                        tagger?: {
                            type: "author";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            raw?: string;
                            user?: (...) & (...) & (...) & (...);
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            target?: {
                                type: "commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                participants?: (...) | (...);
                                repository?: (...) | (...);
                            };
                            type: string;
                        } & {
                            date?: string;
                            message?: string;
                            tagger?: {
                                type: "author";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                raw?: (...) | (...);
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/refs/tags/{name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    name: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                commits?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            target?: {
                                type: "commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                participants?: (...) | (...);
                                repository?: (...) | (...);
                            };
                            type: string;
                        } & {
                            date?: string;
                            message?: string;
                            tagger?: {
                                type: "author";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                raw?: (...) | (...);
                                user?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/src: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    format?: "meta";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                path?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    author?: string;
                    branch?: string;
                    files?: string;
                    message?: string;
                    parents?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/src/{commit}/{path}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commit: string;
                    path: string;
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    format?: "meta" | "rendered";
                    max_depth?: number;
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                commit?: (...) | (...);
                                path?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                555: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/versions: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "version";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/versions/{version_id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    version_id: number;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "version";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            id?: number;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                version_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /repositories/{workspace}/{repo_slug}/watchers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    role?: "contributor" | "member" | "owner";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        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: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: {
                    role?: "contributor" | "member" | "owner";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/form-data: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/related: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                410: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/form-data: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/related: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/{node_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    node_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                405: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    node_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/form-data: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/related: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    node_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/form-data: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                        multipart/related: {
                            type: "snippet";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            id?: number;
                            is_private?: boolean;
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                405: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/form-data: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                        multipart/related: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/{node_id}/files/{path}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    node_id: string;
                    path: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: {
                        Content-Disposition?: string;
                        Content-Type?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/{revision}/diff: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    revision: string;
                    workspace: string;
                };
                query?: {
                    path?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/{revision}/patch: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    revision: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/comments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "snippet_comment";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                snippet?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: (...) & (...) & (...) & (...);
                            id?: number;
                            is_private?: boolean;
                            owner?: (...) & (...) & (...) & (...);
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "snippet_comment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            snippet?: {
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/comments/{comment_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet_comment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            snippet?: {
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    comment_id: number;
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            self?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            creator?: (...) & (...) & (...) & (...);
                            id?: number;
                            is_private?: boolean;
                            owner?: (...) & (...) & (...) & (...);
                            scm?: "git";
                            title?: string;
                            updated_on?: string;
                        };
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet_comment";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: {
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            snippet?: {
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/commits: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "snippet_commit";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                snippet?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/commits/{revision}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    revision: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "snippet_commit";
                        } & Omit<{
                            type: "base_commit";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            author?: (...) & (...) & (...) & (...);
                            date?: string;
                            hash?: string;
                            message?: string;
                            parents?: readonly (...)[];
                            summary?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: {
                                diff?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            snippet?: {
                                type: "snippet";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                creator?: (...) | (...);
                                id?: (...) | (...);
                                is_private?: (...) | (...) | (...);
                                owner?: (...) | (...);
                                scm?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/files/{path}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    path: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                302: {
                    content?: undefined;
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/watch: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /snippets/{workspace}/{encoded_id}/watchers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    encoded_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /teams/{username}/pipelines_config/variables: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_variable";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /teams/{username}/pipelines_config/variables/{variable_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /teams/{username}/search/code: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    username: string;
                };
                query: {
                    page?: number;
                    pagelen?: number;
                    search_query: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            query_substituted?: boolean;
                            size?: number;
                            values?: readonly {
                                content_match_count?: number;
                                content_matches?: readonly (...)[];
                                file?: (...) & (...);
                                path_matches?: readonly (...)[];
                                type?: string;
                            }[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                429: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<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: {
                            type: "account";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /user/emails: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                default: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /user/emails/{email}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    email: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                default: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                email: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /user/permissions/repositories: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                repository?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /user/permissions/workspaces: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "workspace_membership";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                user?: (...) | (...);
                                workspace?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /users/{selected_user}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "account";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            };
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /users/{selected_user}/pipelines_config/variables: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_variable";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /users/{selected_user}/pipelines_config/variables/{variable_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                    variable_uuid: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /users/{selected_user}/properties/{app_key}/{property_name}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            _attributes?: readonly ("public" | "read_only")[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    app_key: string;
                    property_name: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
            };
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /users/{selected_user}/search/code: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query: {
                    page?: number;
                    pagelen?: number;
                    search_query: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            query_substituted?: boolean;
                            size?: number;
                            values?: readonly {
                                content_match_count?: number;
                                content_matches?: readonly (...)[];
                                file?: (...) & (...);
                                path_matches?: readonly (...)[];
                                type?: string;
                            }[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                429: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /users/{selected_user}/ssh-keys: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "ssh_account_key";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                owner?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "ssh_account_key";
                        } & Omit<{
                            type: "ssh_key";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            comment?: string;
                            created_on?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: ...;
                            };
                            uuid?: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /users/{selected_user}/ssh-keys/{key_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "ssh_account_key";
                        } & Omit<{
                            type: "ssh_key";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            comment?: string;
                            created_on?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: ...;
                            };
                            uuid?: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    selected_user: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "ssh_account_key";
                        } & Omit<{
                            type: "ssh_key";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            comment?: string;
                            created_on?: string;
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: ...;
                            };
                            uuid?: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            owner?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    q?: string;
                    role?: "member" | "owner" | "collaborator";
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "workspace";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                is_privacy_enforced?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "workspace";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            is_privacy_enforced?: boolean;
                            is_private?: boolean;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                members?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                owners?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                projects?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                repositories?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                snippets?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            slug?: string;
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/hooks: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "webhook_subscription";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                active?: (...) | (...) | (...);
                                created_at?: (...) | (...);
                                description?: (...) | (...);
                                events?: (...) | (...);
                                secret?: (...) | (...);
                                secret_set?: (...) | (...) | (...);
                                subject?: (...) | (...);
                                subject_type?: (...) | (...) | (...);
                                url?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/hooks/{uid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    uid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "webhook_subscription";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            active?: boolean;
                            created_at?: string;
                            description?: string;
                            events?: readonly (
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated")[];
                            secret?: string;
                            secret_set?: boolean;
                            subject?: Readonly<Record<(...), (...)>> & {
                                type: string;
                            };
                            subject_type?: "repository" | "workspace";
                            url?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/members: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "workspace_membership";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                user?: (...) | (...);
                                workspace?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/members/{member}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    member: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "workspace_membership";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            user?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            workspace?: {
                                type: "workspace";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                is_privacy_enforced?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                member: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/permissions: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: {
                    q?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "workspace_membership";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                user?: (...) | (...);
                                workspace?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/permissions/repositories: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                repository?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/permissions/repositories/{repo_slug}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    repo_slug: string;
                    workspace: string;
                };
                query?: {
                    q?: string;
                    sort?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                repository?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/pipelines-config/variables: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pipeline_variable";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                key?: (...) | (...);
                                secured?: (...) | (...) | (...);
                                uuid?: (...) | (...);
                                value?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                409: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    variable_uuid: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "pipeline_variable";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            key?: string;
                            secured?: boolean;
                            uuid?: string;
                            value?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/projects: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<{
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: (...) & (...) & (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                201: {
                    content: {
                        application/json: {
                            type: "project";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            has_publicly_visible_repos?: boolean;
                            is_private?: boolean;
                            key?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            owner?: {
                                type: "team";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "project";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            has_publicly_visible_repos?: boolean;
                            is_private?: boolean;
                            key?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            owner?: {
                                type: "team";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                            html?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<{
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            links?: (...) & (...) & (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "project";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            has_publicly_visible_repos?: boolean;
                            is_private?: boolean;
                            key?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            owner?: {
                                type: "team";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                201: {
                    content: {
                        application/json: {
                            type: "project";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            description?: string;
                            has_publicly_visible_repos?: boolean;
                            is_private?: boolean;
                            key?: string;
                            links?: {
                                avatar?: {
                                    href?: ...;
                                    name?: ...;
                                };
                                html?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            name?: string;
                            owner?: {
                                type: "team";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                            };
                            updated_on?: string;
                            uuid?: string;
                        };
                    };
                    headers: {
                        Location?: string;
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/branching-model: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "project_branching_model";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix: string;
                            }[];
                            development?: {
                                name: string;
                                use_mainbranch: boolean;
                            };
                            production?: {
                                name: string;
                                use_mainbranch: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/branching-model/settings: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branching_model_settings";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                enabled?: (...) | (...) | (...);
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix?: (...) | (...);
                            }[];
                            development?: {
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            production?: {
                                enabled?: boolean;
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "branching_model_settings";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            branch_types?: readonly {
                                enabled?: (...) | (...) | (...);
                                kind:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                prefix?: (...) | (...);
                            }[];
                            development?: {
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            production?: {
                                enabled?: boolean;
                                is_valid?: boolean;
                                name?: string;
                                use_mainbranch?: boolean;
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/default-reviewers: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                reviewer_type?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "user";
                        } & Omit<{
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            account_id?: string;
                            account_status?: string;
                            has_2fa_enabled?: boolean;
                            is_staff?: boolean;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            } & {
                                html?: (...) | (...);
                                repositories?: (...) | (...);
                                self?: (...) | (...);
                            };
                            nickname?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "user";
                        } & Omit<{
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            account_id?: string;
                            account_status?: string;
                            has_2fa_enabled?: boolean;
                            is_staff?: boolean;
                            links?: Readonly<Record<(...), (...)>> & {
                                avatar?: (...) | (...);
                            } & {
                                html?: (...) | (...);
                                repositories?: (...) | (...);
                                self?: (...) | (...);
                            };
                            nickname?: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/deploy-keys: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "project_deploy_key";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                added_on?: (...) | (...);
                                comment?: (...) | (...);
                                created_by?: (...) | (...);
                                key?: (...) | (...);
                                label?: (...) | (...);
                                last_used?: (...) | (...);
                                links?: (...) | (...);
                                project?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "project_deploy_key";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            added_on?: string;
                            comment?: string;
                            created_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    key_id: string;
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "project_deploy_key";
                        } & Omit<Readonly<Record<string, unknown>> & {
                            type: string;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            added_on?: string;
                            comment?: string;
                            created_by?: {
                                type: "account";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                display_name?: (...) | (...);
                                links?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            key?: string;
                            label?: string;
                            last_used?: string;
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/permissions-config/groups: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                group?: (...) | (...);
                                links?: (...) | (...);
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                project?: (...) | (...);
                                type: string;
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            group?: {
                                type: "group";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                full_slug?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                slug?: (...) | (...);
                                workspace?: (...) | (...);
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "create-repo"
                                | "read"
                                | "write"
                                | "none";
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    group_slug: string;
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        permission:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            group?: {
                                type: "group";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                full_slug?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                slug?: (...) | (...);
                                workspace?: (...) | (...);
                            };
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "create-repo"
                                | "read"
                                | "write"
                                | "none";
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                402: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/permissions-config/users: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly (Readonly<Record<(...), (...)>> & {
                                links?: (...) | (...);
                                permission?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                project?: (...) | (...);
                                type: string;
                                user?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "create-repo"
                                | "read"
                                | "write"
                                | "none";
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                            user?: {
                                type: "user";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                account_id?: (...) | (...);
                                account_status?: (...) | (...);
                                has_2fa_enabled?: (...) | (...) | (...);
                                is_staff?: (...) | (...) | (...);
                                links?: (...) | (...);
                                nickname?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    project_key: string;
                    selected_user_id: string;
                    workspace: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        permission:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            links?: {
                                self?: {
                                    href?: ...;
                                    name?: ...;
                                };
                            };
                            permission?:
                                | "admin"
                                | "create-repo"
                                | "read"
                                | "write"
                                | "none";
                            project?: {
                                type: "project";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                created_on?: (...) | (...);
                                description?: (...) | (...);
                                has_publicly_visible_repos?: (...) | (...) | (...);
                                is_private?: (...) | (...) | (...);
                                key?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                owner?: (...) | (...);
                                updated_on?: (...) | (...);
                                uuid?: (...) | (...);
                            };
                            type: string;
                            user?: {
                                type: "user";
                            } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                account_id?: (...) | (...);
                                account_status?: (...) | (...);
                                has_2fa_enabled?: (...) | (...) | (...);
                                is_staff?: (...) | (...) | (...);
                                links?: (...) | (...);
                                nickname?: (...) | (...);
                            };
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                401: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                402: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                403: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        trace?: undefined;
    };
    /workspaces/{workspace}/pullrequests/{selected_user}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    selected_user: string;
                    workspace: string;
                };
                query?: {
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            size?: number;
                            values?: readonly ({
                                type: "pullrequest";
                            } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                                author?: (...) | (...);
                                close_source_branch?: (...) | (...) | (...);
                                closed_by?: (...) | (...);
                                comment_count?: (...) | (...);
                                created_on?: (...) | (...);
                                destination?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                merge_commit?: (...) | (...);
                                participants?: (...) | (...);
                                reason?: (...) | (...);
                                rendered?: (...) | (...);
                                reviewers?: (...) | (...);
                                source?: (...) | (...);
                                state?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                summary?: (...) | (...);
                                task_count?: (...) | (...);
                                title?: (...) | (...);
                                updated_on?: (...) | (...);
                            })[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /workspaces/{workspace}/search/code: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    workspace: string;
                };
                query: {
                    page?: number;
                    pagelen?: number;
                    search_query: string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            next?: string;
                            page?: number;
                            pagelen?: number;
                            previous?: string;
                            query_substituted?: boolean;
                            size?: number;
                            values?: readonly {
                                content_match_count?: number;
                                content_matches?: readonly (...)[];
                                file?: (...) & (...);
                                path_matches?: readonly (...)[];
                                type?: string;
                            }[];
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                400: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                404: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
                429: {
                    content: {
                        application/json: Readonly<Record<string, unknown>> & {
                            error?: {
                                data?: Readonly<(...)>;
                                detail?: string;
                                message: string;
                            };
                            type: string;
                        };
                    };
                    headers: Readonly<Record<string, unknown>>;
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
}

Properties

/addon /addon/linkers /addon/linkers/{linker_key} /addon/linkers/{linker_key}/values /addon/linkers/{linker_key}/values/{value_id} /hook_events /hook_events/{subject_type} /pullrequests/{selected_user} /repositories /repositories/{workspace} /repositories/{workspace}/{repo_slug} /repositories/{workspace}/{repo_slug}/branch-restrictions /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} /repositories/{workspace}/{repo_slug}/branching-model /repositories/{workspace}/{repo_slug}/branching-model/settings /repositories/{workspace}/{repo_slug}/commit/{commit} /repositories/{workspace}/{repo_slug}/commit/{commit}/approve /repositories/{workspace}/{repo_slug}/commit/{commit}/comments /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests /repositories/{workspace}/{repo_slug}/commit/{commit}/reports /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key} /repositories/{workspace}/{repo_slug}/commits /repositories/{workspace}/{repo_slug}/commits/{revision} /repositories/{workspace}/{repo_slug}/components /repositories/{workspace}/{repo_slug}/components/{component_id} /repositories/{workspace}/{repo_slug}/default-reviewers /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} /repositories/{workspace}/{repo_slug}/deploy-keys /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} /repositories/{workspace}/{repo_slug}/deployments /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid} /repositories/{workspace}/{repo_slug}/diff/{spec} /repositories/{workspace}/{repo_slug}/diffstat/{spec} /repositories/{workspace}/{repo_slug}/downloads /repositories/{workspace}/{repo_slug}/downloads/{filename} /repositories/{workspace}/{repo_slug}/effective-branching-model /repositories/{workspace}/{repo_slug}/effective-default-reviewers /repositories/{workspace}/{repo_slug}/environments /repositories/{workspace}/{repo_slug}/environments/{environment_uuid} /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path} /repositories/{workspace}/{repo_slug}/forks /repositories/{workspace}/{repo_slug}/hooks /repositories/{workspace}/{repo_slug}/hooks/{uid} /repositories/{workspace}/{repo_slug}/issues /repositories/{workspace}/{repo_slug}/issues/{issue_id} /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path} /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id} /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch /repositories/{workspace}/{repo_slug}/issues/export /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip /repositories/{workspace}/{repo_slug}/issues/import /repositories/{workspace}/{repo_slug}/merge-base/{revspec} /repositories/{workspace}/{repo_slug}/milestones /repositories/{workspace}/{repo_slug}/milestones/{milestone_id} /repositories/{workspace}/{repo_slug}/override-settings /repositories/{workspace}/{repo_slug}/patch/{spec} /repositories/{workspace}/{repo_slug}/permissions-config/groups /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} /repositories/{workspace}/{repo_slug}/permissions-config/users /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} /repositories/{workspace}/{repo_slug}/pipelines /repositories/{workspace}/{repo_slug}/pipelines_config /repositories/{workspace}/{repo_slug}/pipelines_config/build_number /repositories/{workspace}/{repo_slug}/pipelines_config/schedules /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} /repositories/{workspace}/{repo_slug}/pipelines_config/variables /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} /repositories/{workspace}/{repo_slug}/pipelines-config/caches /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid} /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid} /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid} /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid} /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} /repositories/{workspace}/{repo_slug}/pullrequests /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id} /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id} /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id} /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} /repositories/{workspace}/{repo_slug}/pullrequests/activity /repositories/{workspace}/{repo_slug}/refs /repositories/{workspace}/{repo_slug}/refs/branches /repositories/{workspace}/{repo_slug}/refs/branches/{name} /repositories/{workspace}/{repo_slug}/refs/tags /repositories/{workspace}/{repo_slug}/refs/tags/{name} /repositories/{workspace}/{repo_slug}/src /repositories/{workspace}/{repo_slug}/src/{commit}/{path} /repositories/{workspace}/{repo_slug}/versions /repositories/{workspace}/{repo_slug}/versions/{version_id} /repositories/{workspace}/{repo_slug}/watchers /snippets /snippets/{workspace} /snippets/{workspace}/{encoded_id} /snippets/{workspace}/{encoded_id}/{node_id} /snippets/{workspace}/{encoded_id}/{node_id}/files/{path} /snippets/{workspace}/{encoded_id}/{revision}/diff /snippets/{workspace}/{encoded_id}/{revision}/patch /snippets/{workspace}/{encoded_id}/comments /snippets/{workspace}/{encoded_id}/comments/{comment_id} /snippets/{workspace}/{encoded_id}/commits /snippets/{workspace}/{encoded_id}/commits/{revision} /snippets/{workspace}/{encoded_id}/files/{path} /snippets/{workspace}/{encoded_id}/watch /snippets/{workspace}/{encoded_id}/watchers /teams/{username}/pipelines_config/variables /teams/{username}/pipelines_config/variables/{variable_uuid} /teams/{username}/search/code /user /user/emails /user/emails/{email} /user/permissions/repositories /user/permissions/workspaces /users/{selected_user} /users/{selected_user}/pipelines_config/variables /users/{selected_user}/pipelines_config/variables/{variable_uuid} /users/{selected_user}/properties/{app_key}/{property_name} /users/{selected_user}/search/code /users/{selected_user}/ssh-keys /users/{selected_user}/ssh-keys/{key_id} /workspaces /workspaces/{workspace} /workspaces/{workspace}/hooks /workspaces/{workspace}/hooks/{uid} /workspaces/{workspace}/members /workspaces/{workspace}/members/{member} /workspaces/{workspace}/permissions /workspaces/{workspace}/permissions/repositories /workspaces/{workspace}/permissions/repositories/{repo_slug} /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json /workspaces/{workspace}/pipelines-config/variables /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} /workspaces/{workspace}/projects /workspaces/{workspace}/projects/{project_key} /workspaces/{workspace}/projects/{project_key}/branching-model /workspaces/{workspace}/projects/{project_key}/branching-model/settings /workspaces/{workspace}/projects/{project_key}/default-reviewers /workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user} /workspaces/{workspace}/projects/{project_key}/deploy-keys /workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id} /workspaces/{workspace}/projects/{project_key}/permissions-config/groups /workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug} /workspaces/{workspace}/projects/{project_key}/permissions-config/users /workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id} /workspaces/{workspace}/pullrequests/{selected_user} /workspaces/{workspace}/search/code

Properties

/addon: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an app

    Deletes the application for the user.

    This endpoint is intended to be used by Bitbucket Connect apps
    and only supports JWT authentication -- that is how Bitbucket
    identifies the particular installation of the app. Developers
    with applications registered in the "Develop Apps" section
    of Bitbucket Marketplace need not use this endpoint as
    updates for those applications can be sent out via the
    UI of that section.
    
    ```
    $ curl -X DELETE https://api.bitbucket.org/2.0/addon \
      -H "Authorization: JWT <JWT Token>"
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Request has succeeded. The application has been deleted for the user.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No authorization.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Improper authentication.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an installed app

    Updates the application installation for the user.

    This endpoint is intended to be used by Bitbucket Connect apps
    and only supports JWT authentication -- that is how Bitbucket
    identifies the particular installation of the app. Developers
    with applications registered in the "Develop Apps" section
    of Bitbucket need not use this endpoint as updates for those
    applications can be sent out via the UI of that section.
    
    Passing an empty body will update the installation using the
    existing descriptor URL.
    
    ```
    $ curl -X PUT https://api.bitbucket.org/2.0/addon \
      -H "Authorization: JWT <JWT Token>" \
      --header "Content-Type: application/json" \
      --data '{}'
    ```
    
    The new `descriptor` for the installation can be also provided
    in the body directly.
    
    ```
    $ curl -X PUT https://api.bitbucket.org/2.0/addon \
      -H "Authorization: JWT <JWT Token>" \
      --header "Content-Type: application/json" \
      --data '{"descriptor": $NEW_DESCRIPTOR}'
    ```
    
    In both these modes the URL of the descriptor cannot be changed. To
    change the descriptor location and upgrade an installation
    the request must be made exclusively with a `descriptor_url`.
    
     ```
    $ curl -X PUT https://api.bitbucket.org/2.0/addon \
      -H "Authorization: JWT <JWT Token>" \
      --header "Content-Type: application/json" \
      --data '{"descriptor_url": $NEW_URL}'
    ```
    
    The `descriptor_url` must exactly match the marketplace registration
    that Atlassian has for the application. Contact your Atlassian
    developer advocate to update this registration. Once the registration
    has been updated you may call this resource for each installation.
    
    Note that the scopes of the application cannot be increased
    in the new descriptor nor reduced to none.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Request has succeeded. The installation has been updated to the new descriptor.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Scopes have increased or decreased to none.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No authorization.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Improper authentication.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/addon/linkers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List linkers for an app

    Gets a list of all linkers for the authenticated application.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/addon/linkers/{linker_key}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a linker for an app

    Gets a linker specified by linker_key for the authenticated application.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          linker_key: string;
      }
      • Readonlylinker_key: string

        The unique key of a linker module as defined in an application descriptor.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/addon/linkers/{linker_key}/values: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete all linker values

    Delete all linker values for the specified linker of the authenticated application.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successfully deleted the linker values.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List linker values for a linker

    Gets a list of all linker values for the specified linker of the authenticated application.

    A linker value lets applications supply values to modify its regular expression.
    
    The base regular expression must use a Bitbucket-specific match group `(?K)`
    which will be translated to `([\w\-]+)`. A value must match this pattern.
    
    [Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          linker_key: string;
      }
      • Readonlylinker_key: string

        The unique key of a linker module as defined in an application descriptor.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a linker value

    Creates a linker value for the specified linker of authenticated application.

    A linker value lets applications supply values to modify its regular expression.
    
    The base regular expression must use a Bitbucket-specific match group `(?K)`
    which will be translated to `([\w\-]+)`. A value must match this pattern.
    
    [Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successfully created the linker value.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker already has the value being added.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a linker value

    Bulk update linker values for the specified linker of the authenticated application.

    A linker value lets applications supply values to modify its regular expression.
    
    The base regular expression must use a Bitbucket-specific match group `(?K)`
    which will be translated to `([\w\-]+)`. A value must match this pattern.
    
    [Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successfully updated the linker values.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Invalid input.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/addon/linkers/{linker_key}/values/{value_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
                value_id: number;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
                value_id: number;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
            value_id: number;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
                value_id: number;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a linker value

    Delete a single linker value of the authenticated application.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
              value_id: number;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
            value_id: number;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

        • Readonlyvalue_id: number

          The numeric ID of the linker value.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successfully deleted the linker value.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker value does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                linker_key: string;
                value_id: number;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a linker value

    Get a single linker value of the authenticated application.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              linker_key: string;
              value_id: number;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            linker_key: string;
            value_id: number;
        }
        • Readonlylinker_key: string

          The unique key of a linker module as defined in an application descriptor.

        • Readonlyvalue_id: number

          The numeric ID of the linker value.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Authentication must use app JWT

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The linker value does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            linker_key: string;
            value_id: number;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          linker_key: string;
          value_id: number;
      }
      • Readonlylinker_key: string

        The unique key of a linker module as defined in an application descriptor.

      • Readonlyvalue_id: number

        The numeric ID of the linker value.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/hook_events: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        repository?: {
                            events?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        workspace?: {
                            events?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        repository?: {
                            events?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                        workspace?: {
                            events?: {
                                href?: (...) | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a webhook resource

    Returns the webhook resource or subject types on which webhooks can be registered.

    Each resource/subject type contains an `events` link that returns the
    paginated list of specific events each individual subject type can
    emit.
    
    This endpoint is publicly accessible and does not require
    authentication or scopes.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      repository?: {
                          events?: {
                              href?: (...) | (...);
                              name?: (...) | (...);
                          };
                      };
                      workspace?: {
                          events?: {
                              href?: (...) | (...);
                              name?: (...) | (...);
                          };
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    repository?: {
                        events?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    workspace?: {
                        events?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A mapping of resource/subject types pointing to their individual event types.

        • content: {
              application/json: {
                  repository?: {
                      events?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  workspace?: {
                      events?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
              };
          }
          • Readonlyapplication/json: {
                repository?: {
                    events?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                workspace?: {
                    events?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
            }
            • Optional Readonlyrepository?: {
                  events?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              }
              • Optional Readonlyevents?: {
                    href?: (...) | (...);
                    name?: (...) | (...);
                }

                Link

                A link to a resource related to this object.

                • Optional Readonlyhref?: (...) | (...)

                  Format: uri

                • Optional Readonlyname?: (...) | (...)
            • Optional Readonlyworkspace?: {
                  events?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              }
              • Optional Readonlyevents?: {
                    href?: (...) | (...);
                    name?: (...) | (...);
                }

                Link

                A link to a resource related to this object.

                • Optional Readonlyhref?: (...) | (...)

                  Format: uri

                • Optional Readonlyname?: (...) | (...)
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/hook_events/{subject_type}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                subject_type: "repository" | "workspace";
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly {
                            category?: string;
                            description?: string;
                            event?:
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated";
                            label?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            subject_type: "repository" | "workspace";
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                subject_type: "repository" | "workspace";
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly {
                            category?: string;
                            description?: string;
                            event?:
                                | "issue:comment_created"
                                | "issue:created"
                                | "issue:updated"
                                | "project:updated"
                                | "pullrequest:approved"
                                | "pullrequest:changes_request_created"
                                | "pullrequest:changes_request_removed"
                                | "pullrequest:comment_created"
                                | "pullrequest:comment_deleted"
                                | "pullrequest:comment_reopened"
                                | "pullrequest:comment_resolved"
                                | "pullrequest:comment_updated"
                                | "pullrequest:created"
                                | "pullrequest:fulfilled"
                                | "pullrequest:push"
                                | "pullrequest:rejected"
                                | "pullrequest:unapproved"
                                | "pullrequest:updated"
                                | "repo:commit_comment_created"
                                | "repo:commit_status_created"
                                | "repo:commit_status_updated"
                                | "repo:created"
                                | "repo:deleted"
                                | "repo:fork"
                                | "repo:imported"
                                | "repo:push"
                                | "repo:transfer"
                                | "repo:updated";
                            label?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List subscribable webhook types

    Returns a paginated list of all valid webhook events for the specified entity. The team and user webhooks are deprecated, and you should use workspace instead. For more information, see the announcement.

    This is public data that does not require any scopes or authentication.
    
    NOTE: The example response is a truncated response object for the `workspace` `subject_type`.
    We return the same structure for the other `subject_type` objects.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              subject_type: "repository" | "workspace";
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            subject_type: "repository" | "workspace";
        }
        • Readonlysubject_type: "repository" | "workspace"

          A resource or subject type.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly {
                          category?: string;
                          description?: string;
                          event?:
                              | "issue:comment_created"
                              | "issue:created"
                              | "issue:updated"
                              | "project:updated"
                              | "pullrequest:approved"
                              | "pullrequest:changes_request_created"
                              | "pullrequest:changes_request_removed"
                              | "pullrequest:comment_created"
                              | "pullrequest:comment_deleted"
                              | "pullrequest:comment_reopened"
                              | "pullrequest:comment_resolved"
                              | "pullrequest:comment_updated"
                              | "pullrequest:created"
                              | "pullrequest:fulfilled"
                              | "pullrequest:push"
                              | "pullrequest:rejected"
                              | "pullrequest:unapproved"
                              | "pullrequest:updated"
                              | "repo:commit_comment_created"
                              | "repo:commit_status_created"
                              | "repo:commit_status_updated"
                              | "repo:created"
                              | "repo:deleted"
                              | "repo:fork"
                              | "repo:imported"
                              | "repo:push"
                              | "repo:transfer"
                              | "repo:updated";
                          label?: string;
                      }[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly {
                        category?: string;
                        description?: string;
                        event?:
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated";
                        label?: string;
                    }[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of webhook types available to subscribe on.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly {
                      category?: string;
                      description?: string;
                      event?:
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated";
                      label?: string;
                  }[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly {
                    category?: string;
                    description?: string;
                    event?:
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated";
                    label?: string;
                }[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly {
                  category?: string;
                  description?: string;
                  event?:
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated";
                  label?: string;
              }[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If an invalid {subject_type} value was specified.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            subject_type: "repository" | "workspace";
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          subject_type: "repository" | "workspace";
      }
      • Readonlysubject_type: "repository" | "workspace"

        A resource or subject type.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/pullrequests/{selected_user}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List pull requests for a user

    Returns all pull requests authored by the specified user.

    By default only open pull requests are returned. This can be controlled
    using the `state` query parameter. To retrieve pull requests that are
    in one of multiple states, repeat the `state` parameter for each
    individual state.
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: {
              state?:
                  | "DECLINED"
                  | "MERGED"
                  | "OPEN"
                  | "SUPERSEDED";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          This can either be the username of the pull request author, the author's UUID surrounded by curly-braces, for example: {account UUID}, or the author's Atlassian ID.

      • Optional Readonlyquery?: {
            state?:
                | "DECLINED"
                | "MERGED"
                | "OPEN"
                | "SUPERSEDED";
        }
        • Optional Readonlystate?:
              | "DECLINED"
              | "MERGED"
              | "OPEN"
              | "SUPERSEDED"

          Only return pull requests that are in this state. This parameter can be repeated.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All pull requests authored by the specified user.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  close_source_branch?: (...) | (...) | (...);
                  closed_by?: (...) | (...);
                  comment_count?: (...) | (...);
                  created_on?: (...) | (...);
                  destination?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  merge_commit?: (...) | (...);
                  participants?: (...) | (...);
                  reason?: (...) | (...);
                  rendered?: (...) | (...);
                  reviewers?: (...) | (...);
                  source?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  task_count?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          selected_user: string;
      }
      • Readonlyselected_user: string

        This can either be the username of the pull request author, the author's UUID surrounded by curly-braces, for example: {account UUID}, or the author's Atlassian ID.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                after?: string;
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                after?: string;
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List public repositories

    Returns a paginated list of all public repositories.

    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              after?: string;
              q?: string;
              role?:
                  | "admin"
                  | "contributor"
                  | "member"
                  | "owner";
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: {
            after?: string;
            q?: string;
            role?:
                | "admin"
                | "contributor"
                | "member"
                | "owner";
            sort?: string;
        }
        • Optional Readonlyafter?: string

          Filter the results to include only repositories created on or after this ISO-8601 timestamp. Example: YYYY-MM-DDTHH:mm:ss.sssZ

        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting. role parameter must also be specified.

        • Optional Readonlyrole?:
              | "admin"
              | "contributor"
              | "member"
              | "owner"

          Filters the result based on the authenticated user's role on each repository.

          * **member**: returns repositories to which the user has explicit read access
          * **contributor**: returns repositories to which the user has explicit write access
          * **admin**: returns repositories to which the user has explicit administrator access
          * **owner**: returns all repositories owned by the current user
          
        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: (...) | (...);
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: (...) | (...);
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All public repositories.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: (...) | (...);
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: (...) | (...);
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "repository";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  fork_policy?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  full_name?: (...) | (...);
                  has_issues?: (...) | (...) | (...);
                  has_wiki?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  language?: (...) | (...);
                  links?: (...) | (...);
                  mainbranch?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  parent?: (...) | (...);
                  project?: (...) | (...);
                  scm?: (...) | (...);
                  size?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List repositories in a workspace

    Returns a paginated list of all repositories owned by the specified workspace.

    The result can be narrowed down based on the authenticated user's role.
    
    E.g. with `?role=contributor`, only those repositories that the
    authenticated user has write access to are returned (this includes any
    repo the user is an admin on, as that implies write access).
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: {
              q?: string;
              role?:
                  | "admin"
                  | "contributor"
                  | "member"
                  | "owner";
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            role?:
                | "admin"
                | "contributor"
                | "member"
                | "owner";
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlyrole?:
              | "admin"
              | "contributor"
              | "member"
              | "owner"

          Filters the result based on the authenticated user's role on each repository.

          * **member**: returns repositories to which the user has explicit read access
          * **contributor**: returns repositories to which the user has explicit write access
          * **admin**: returns repositories to which the user has explicit administrator access
          * **owner**: returns all repositories owned by the current user
          
        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: (...) | (...);
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          410: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: (...) | (...);
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repositories owned by the specified account.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: (...) | (...);
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: (...) | (...);
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "repository";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  fork_policy?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  full_name?: (...) | (...);
                  has_issues?: (...) | (...) | (...);
                  has_wiki?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  language?: (...) | (...);
                  links?: (...) | (...);
                  mainbranch?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  parent?: (...) | (...);
                  project?: (...) | (...);
                  scm?: (...) | (...);
                  size?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified account does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly410: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified account marked as spam.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                redirect_to?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            201: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                redirect_to?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a repository

    Deletes the repository. This is an irreversible operation.

    This does not affect its forks.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              redirect_to?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            redirect_to?: string;
        }
        • Optional Readonlyredirect_to?: string

          If a repository has been moved to a new location, use this parameter to show users a friendly message in the Bitbucket UI that the repository has moved to a new location. However, a GET to this endpoint will still return a 404.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates successful deletion.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the caller either does not have admin access to the repository, or the repository is set to read-only.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a repository

    Returns the object describing this repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "repository";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          clone?: readonly (...)[];
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          downloads?: {
                              href?: ...;
                              name?: ...;
                          };
                          forks?: {
                              href?: ...;
                              name?: ...;
                          };
                          hooks?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          pullrequests?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          watchers?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      mainbranch?: Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      };
                      name?: string;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository object.

        • content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If no repository exists at this location.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a repository

    Creates a new repository.

    Note: In order to set the project for the newly created repository,
    pass in either the project key or the project UUID as part of the
    request body as shown in the examples below:
    
    ```
    $ curl -X POST -H "Content-Type: application/json" -d '{
        "scm": "git",
        "project": {
            "key": "MARS"
        }
    }' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding
    ```
    
    or
    
    ```
    $ curl -X POST -H "Content-Type: application/json" -d '{
        "scm": "git",
        "project": {
            "key": "{ba516952-992a-4c2d-acbd-17d502922f96}"
        }
    }' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding
    ```
    
    The project must be assigned for all repositories. If the project is not provided,
    the repository is automatically assigned to the oldest project in the workspace.
    
    Note: In the examples above, the workspace ID `teamsinspace`,
    and/or the repository name `hablanding` can be replaced by UUIDs.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }

      The repository that is to be created. Note that most object elements are optional. Elements "owner" and "full_name" are ignored as the URL implies them.

      • Readonlycontent: {
            application/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "repository";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
              full_name?: string;
              has_issues?: boolean;
              has_wiki?: boolean;
              is_private?: boolean;
              language?: string;
              links?: {
                  avatar?: {
                      href?: ...;
                      name?: ...;
                  };
                  clone?: readonly (...)[];
                  commits?: {
                      href?: ...;
                      name?: ...;
                  };
                  downloads?: {
                      href?: ...;
                      name?: ...;
                  };
                  forks?: {
                      href?: ...;
                      name?: ...;
                  };
                  hooks?: {
                      href?: ...;
                      name?: ...;
                  };
                  html?: {
                      href?: ...;
                      name?: ...;
                  };
                  pullrequests?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
                  watchers?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              mainbranch?: Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              } & {
                  default_merge_strategy?: (...) | (...);
                  merge_strategies?: (...) | (...);
              };
              name?: string;
              owner?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              project?: {
                  type: "project";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  has_publicly_visible_repos?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              };
              scm?: "git";
              size?: number;
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "repository";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          clone?: readonly (...)[];
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          downloads?: {
                              href?: ...;
                              name?: ...;
                          };
                          forks?: {
                              href?: ...;
                              name?: ...;
                          };
                          hooks?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          pullrequests?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          watchers?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      mainbranch?: Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      };
                      name?: string;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly created repository.

        • content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            201: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a repository

    Since this endpoint can be used to both update and to create a repository, the request body depends on the intent.

    #### Creation
    
    See the POST documentation for the repository endpoint for an example
    of the request body.
    
    #### Update
    
    Note: Changing the `name` of the repository will cause the location to
    be changed. This is because the URL of the repo is derived from the
    name (a process called slugification). In such a scenario, it is
    possible for the request to fail if the newly created slug conflicts
    with an existing repository's slug. But if there is no conflict,
    the new location will be returned in the `Location` header of the
    response.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }

      The repository that is to be updated.

      Note that the elements "owner" and "full_name" are ignored since the
      URL implies them.
      
      • Readonlycontent: {
            application/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "repository";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
              full_name?: string;
              has_issues?: boolean;
              has_wiki?: boolean;
              is_private?: boolean;
              language?: string;
              links?: {
                  avatar?: {
                      href?: ...;
                      name?: ...;
                  };
                  clone?: readonly (...)[];
                  commits?: {
                      href?: ...;
                      name?: ...;
                  };
                  downloads?: {
                      href?: ...;
                      name?: ...;
                  };
                  forks?: {
                      href?: ...;
                      name?: ...;
                  };
                  hooks?: {
                      href?: ...;
                      name?: ...;
                  };
                  html?: {
                      href?: ...;
                      name?: ...;
                  };
                  pullrequests?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
                  watchers?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              mainbranch?: Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              } & {
                  default_merge_strategy?: (...) | (...);
                  merge_strategies?: (...) | (...);
              };
              name?: string;
              owner?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              project?: {
                  type: "project";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  has_publicly_visible_repos?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              };
              scm?: "git";
              size?: number;
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "repository";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          clone?: readonly (...)[];
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          downloads?: {
                              href?: ...;
                              name?: ...;
                          };
                          forks?: {
                              href?: ...;
                              name?: ...;
                          };
                          hooks?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          pullrequests?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          watchers?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      mainbranch?: Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      };
                      name?: string;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          201: {
              content: {
                  application/json: {
                      type: "repository";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          clone?: readonly (...)[];
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          downloads?: {
                              href?: ...;
                              name?: ...;
                          };
                          forks?: {
                              href?: ...;
                              name?: ...;
                          };
                          hooks?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          pullrequests?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          watchers?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      mainbranch?: Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      };
                      name?: string;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The existing repository has been updated

        • content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the repository. This header is only provided when the repository's name is changed.

      • Readonly201: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        A new repository has been created

        • content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly created repository

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/branch-restrictions: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                kind?: string;
                pattern?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "branchrestriction";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            branch_match_kind: (...) | (...);
                            branch_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            groups?: (...) | (...);
                            id?: (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            pattern: string;
                            users?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                    value?: number;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                kind?: string;
                pattern?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "branchrestriction";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            branch_match_kind: (...) | (...);
                            branch_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            groups?: (...) | (...);
                            id?: (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            pattern: string;
                            users?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List branch restrictions

    Returns a paginated list of all branch restrictions on the repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              kind?: string;
              pattern?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            kind?: string;
            pattern?: string;
        }
        • Optional Readonlykind?: string

          Branch restrictions of this type

        • Optional Readonlypattern?: string

          Branch restrictions applied to branches of this pattern

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "branchrestriction";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          branch_match_kind: (...) | (...);
                          branch_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          groups?: (...) | (...);
                          id?: (...) | (...);
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          pattern: string;
                          users?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "branchrestriction";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        branch_match_kind: (...) | (...);
                        branch_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        groups?: (...) | (...);
                        id?: (...) | (...);
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        pattern: string;
                        users?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of branch restrictions

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "branchrestriction";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      branch_match_kind: (...) | (...);
                      branch_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      groups?: (...) | (...);
                      id?: (...) | (...);
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      pattern: string;
                      users?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "branchrestriction";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    branch_match_kind: (...) | (...);
                    branch_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    groups?: (...) | (...);
                    id?: (...) | (...);
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    pattern: string;
                    users?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "branchrestriction";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  branch_match_kind: (...) | (...);
                  branch_type?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  groups?: (...) | (...);
                  id?: (...) | (...);
                  kind:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  links?: (...) | (...);
                  pattern: string;
                  users?: (...) | (...);
                  value?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                    value?: number;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a branch restriction rule

    Creates a new branch restriction rule for a repository.

    `kind` describes what will be restricted. Allowed values include:
    `push`, `force`, `delete`, `restrict_merges`, `require_tasks_to_be_completed`,
    `require_approvals_to_merge`, `require_default_reviewer_approvals_to_merge`,
    `require_no_changes_requested`, `require_passing_builds_to_merge`, `require_commits_behind`,
    `reset_pullrequest_approvals_on_change`, `smart_reset_pullrequest_approvals`,
    `reset_pullrequest_changes_requested_on_change`, `require_all_dependencies_merged`,
    `enforce_merge_checks`, and `allow_auto_merge_when_builds_pass`.
    
    Different kinds of branch restrictions have different requirements:
    
    * `push` and `restrict_merges` require `users` and `groups` to be
      specified. Empty lists are allowed, in which case permission is
      denied for everybody.
    
    The restriction applies to all branches that match. There are
    two ways to match a branch. It is configured in `branch_match_kind`:
    
    1. `glob`: Matches a branch against the `pattern`. A `'*'` in
       `pattern` will expand to match zero or more characters, and every
       other character matches itself. For example, `'foo*'` will match
       `'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all
       branches.
    2. `branching_model`: Matches a branch against the repository's
       branching model. The `branch_type` controls the type of branch
       to match. Allowed values include: `production`, `development`,
       `bugfix`, `release`, `feature` and `hotfix`.
    
    The combination of `kind` and match must be unique. This means that
    two `glob` restrictions in a repository cannot have the same `kind` and
    `pattern`. Additionally, two `branching_model` restrictions in a
    repository cannot have the same `kind` and `branch_type`.
    
    `users` and `groups` are lists of users and groups that are except from
    the restriction. They can only be configured in `push` and
    `restrict_merges` restrictions. The `push` restriction stops a user
    pushing to matching branches unless that user is in `users` or is a
    member of a group in `groups`. The `restrict_merges` stops a user
    merging pull requests to matching branches unless that user is in
    `users` or is a member of a group in `groups`. Adding new users or
    groups to an existing restriction should be done via `PUT`.
    
    Note that branch restrictions with overlapping matchers is allowed,
    but the resulting behavior may be surprising.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "branchrestriction";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_match_kind: "branching_model" | "glob";
                  branch_type?:
                      | "bugfix"
                      | "feature"
                      | "hotfix"
                      | "release"
                      | "development"
                      | "production";
                  groups?: readonly ({
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  })[];
                  id?: number;
                  kind:
                      | "allow_auto_merge_when_builds_pass"
                      | "delete"
                      | "enforce_merge_checks"
                      | "force"
                      | "push"
                      | "require_all_comments_resolved"
                      | "require_all_dependencies_merged"
                      | "require_approvals_to_merge"
                      | "require_commits_behind"
                      | "require_default_reviewer_approvals_to_merge"
                      | "require_no_changes_requested"
                      | "require_passing_builds_to_merge"
                      | "require_review_group_approvals_to_merge"
                      | "require_tasks_to_be_completed"
                      | "reset_pullrequest_approvals_on_change"
                      | "reset_pullrequest_changes_requested_on_change"
                      | "restrict_merges"
                      | "smart_reset_pullrequest_approvals";
                  links?: {
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  pattern: string;
                  users?: readonly ({
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
                  value?: number;
              };
          };
      }

      The new rule

      • Readonlycontent: {
            application/json: {
                type: "branchrestriction";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_match_kind: "branching_model" | "glob";
                branch_type?:
                    | "bugfix"
                    | "feature"
                    | "hotfix"
                    | "release"
                    | "development"
                    | "production";
                groups?: readonly ({
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                })[];
                id?: number;
                kind:
                    | "allow_auto_merge_when_builds_pass"
                    | "delete"
                    | "enforce_merge_checks"
                    | "force"
                    | "push"
                    | "require_all_comments_resolved"
                    | "require_all_dependencies_merged"
                    | "require_approvals_to_merge"
                    | "require_commits_behind"
                    | "require_default_reviewer_approvals_to_merge"
                    | "require_no_changes_requested"
                    | "require_passing_builds_to_merge"
                    | "require_review_group_approvals_to_merge"
                    | "require_tasks_to_be_completed"
                    | "reset_pullrequest_approvals_on_change"
                    | "reset_pullrequest_changes_requested_on_change"
                    | "restrict_merges"
                    | "smart_reset_pullrequest_approvals";
                links?: {
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                pattern: string;
                users?: readonly ({
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
                value?: number;
            };
        }
        • Readonlyapplication/json: {
              type: "branchrestriction";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              branch_match_kind: "branching_model" | "glob";
              branch_type?:
                  | "bugfix"
                  | "feature"
                  | "hotfix"
                  | "release"
                  | "development"
                  | "production";
              groups?: readonly ({
                  type: "group";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  full_slug?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  slug?: (...) | (...);
                  workspace?: (...) | (...);
              })[];
              id?: number;
              kind:
                  | "allow_auto_merge_when_builds_pass"
                  | "delete"
                  | "enforce_merge_checks"
                  | "force"
                  | "push"
                  | "require_all_comments_resolved"
                  | "require_all_dependencies_merged"
                  | "require_approvals_to_merge"
                  | "require_commits_behind"
                  | "require_default_reviewer_approvals_to_merge"
                  | "require_no_changes_requested"
                  | "require_passing_builds_to_merge"
                  | "require_review_group_approvals_to_merge"
                  | "require_tasks_to_be_completed"
                  | "reset_pullrequest_approvals_on_change"
                  | "reset_pullrequest_changes_requested_on_change"
                  | "restrict_merges"
                  | "smart_reset_pullrequest_approvals";
              links?: {
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              pattern: string;
              users?: readonly ({
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              })[];
              value?: number;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "branchrestriction";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_match_kind: "branching_model" | "glob";
                      branch_type?:
                          | "bugfix"
                          | "feature"
                          | "hotfix"
                          | "release"
                          | "development"
                          | "production";
                      groups?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          full_slug?: ...;
                          links?: ...;
                          name?: ...;
                          owner?: ...;
                          slug?: ...;
                          workspace?: ...;
                      })[];
                      id?: number;
                      kind:
                          | "allow_auto_merge_when_builds_pass"
                          | "delete"
                          | "enforce_merge_checks"
                          | "force"
                          | "push"
                          | "require_all_comments_resolved"
                          | "require_all_dependencies_merged"
                          | "require_approvals_to_merge"
                          | "require_commits_behind"
                          | "require_default_reviewer_approvals_to_merge"
                          | "require_no_changes_requested"
                          | "require_passing_builds_to_merge"
                          | "require_review_group_approvals_to_merge"
                          | "require_tasks_to_be_completed"
                          | "reset_pullrequest_approvals_on_change"
                          | "reset_pullrequest_changes_requested_on_change"
                          | "restrict_merges"
                          | "smart_reset_pullrequest_approvals";
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      pattern: string;
                      users?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      value?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        full_slug?: ...;
                        links?: ...;
                        name?: ...;
                        owner?: ...;
                        slug?: ...;
                        workspace?: ...;
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    value?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of branch restrictions

        • content: {
              application/json: {
                  type: "branchrestriction";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_match_kind: "branching_model" | "glob";
                  branch_type?:
                      | "bugfix"
                      | "feature"
                      | "hotfix"
                      | "release"
                      | "development"
                      | "production";
                  groups?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      full_slug?: ...;
                      links?: ...;
                      name?: ...;
                      owner?: ...;
                      slug?: ...;
                      workspace?: ...;
                  })[];
                  id?: number;
                  kind:
                      | "allow_auto_merge_when_builds_pass"
                      | "delete"
                      | "enforce_merge_checks"
                      | "force"
                      | "push"
                      | "require_all_comments_resolved"
                      | "require_all_dependencies_merged"
                      | "require_approvals_to_merge"
                      | "require_commits_behind"
                      | "require_default_reviewer_approvals_to_merge"
                      | "require_no_changes_requested"
                      | "require_passing_builds_to_merge"
                      | "require_review_group_approvals_to_merge"
                      | "require_tasks_to_be_completed"
                      | "reset_pullrequest_approvals_on_change"
                      | "reset_pullrequest_changes_requested_on_change"
                      | "restrict_merges"
                      | "smart_reset_pullrequest_approvals";
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  pattern: string;
                  users?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  value?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "branchrestriction";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_match_kind: "branching_model" | "glob";
                branch_type?:
                    | "bugfix"
                    | "feature"
                    | "hotfix"
                    | "release"
                    | "development"
                    | "production";
                groups?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    full_slug?: ...;
                    links?: ...;
                    name?: ...;
                    owner?: ...;
                    slug?: ...;
                    workspace?: ...;
                })[];
                id?: number;
                kind:
                    | "allow_auto_merge_when_builds_pass"
                    | "delete"
                    | "enforce_merge_checks"
                    | "force"
                    | "push"
                    | "require_all_comments_resolved"
                    | "require_all_dependencies_merged"
                    | "require_approvals_to_merge"
                    | "require_commits_behind"
                    | "require_default_reviewer_approvals_to_merge"
                    | "require_no_changes_requested"
                    | "require_passing_builds_to_merge"
                    | "require_review_group_approvals_to_merge"
                    | "require_tasks_to_be_completed"
                    | "reset_pullrequest_approvals_on_change"
                    | "reset_pullrequest_changes_requested_on_change"
                    | "restrict_merges"
                    | "smart_reset_pullrequest_approvals";
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                pattern: string;
                users?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                value?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                    value?: number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a branch restriction rule

    Deletes an existing branch restriction rule.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyid: string

          The restriction rule's id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }
        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or branch restriction id does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a branch restriction rule

    Returns a specific branch restriction rule.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyid: string

          The restriction rule's id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branchrestriction";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_match_kind: "branching_model" | "glob";
                      branch_type?:
                          | "bugfix"
                          | "feature"
                          | "hotfix"
                          | "release"
                          | "development"
                          | "production";
                      groups?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          full_slug?: ...;
                          links?: ...;
                          name?: ...;
                          owner?: ...;
                          slug?: ...;
                          workspace?: ...;
                      })[];
                      id?: number;
                      kind:
                          | "allow_auto_merge_when_builds_pass"
                          | "delete"
                          | "enforce_merge_checks"
                          | "force"
                          | "push"
                          | "require_all_comments_resolved"
                          | "require_all_dependencies_merged"
                          | "require_approvals_to_merge"
                          | "require_commits_behind"
                          | "require_default_reviewer_approvals_to_merge"
                          | "require_no_changes_requested"
                          | "require_passing_builds_to_merge"
                          | "require_review_group_approvals_to_merge"
                          | "require_tasks_to_be_completed"
                          | "reset_pullrequest_approvals_on_change"
                          | "reset_pullrequest_changes_requested_on_change"
                          | "restrict_merges"
                          | "smart_reset_pullrequest_approvals";
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      pattern: string;
                      users?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      value?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        full_slug?: ...;
                        links?: ...;
                        name?: ...;
                        owner?: ...;
                        slug?: ...;
                        workspace?: ...;
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    value?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branch restriction rule

        • content: {
              application/json: {
                  type: "branchrestriction";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_match_kind: "branching_model" | "glob";
                  branch_type?:
                      | "bugfix"
                      | "feature"
                      | "hotfix"
                      | "release"
                      | "development"
                      | "production";
                  groups?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      full_slug?: ...;
                      links?: ...;
                      name?: ...;
                      owner?: ...;
                      slug?: ...;
                      workspace?: ...;
                  })[];
                  id?: number;
                  kind:
                      | "allow_auto_merge_when_builds_pass"
                      | "delete"
                      | "enforce_merge_checks"
                      | "force"
                      | "push"
                      | "require_all_comments_resolved"
                      | "require_all_dependencies_merged"
                      | "require_approvals_to_merge"
                      | "require_commits_behind"
                      | "require_default_reviewer_approvals_to_merge"
                      | "require_no_changes_requested"
                      | "require_passing_builds_to_merge"
                      | "require_review_group_approvals_to_merge"
                      | "require_tasks_to_be_completed"
                      | "reset_pullrequest_approvals_on_change"
                      | "reset_pullrequest_changes_requested_on_change"
                      | "restrict_merges"
                      | "smart_reset_pullrequest_approvals";
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  pattern: string;
                  users?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  value?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "branchrestriction";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_match_kind: "branching_model" | "glob";
                branch_type?:
                    | "bugfix"
                    | "feature"
                    | "hotfix"
                    | "release"
                    | "development"
                    | "production";
                groups?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    full_slug?: ...;
                    links?: ...;
                    name?: ...;
                    owner?: ...;
                    slug?: ...;
                    workspace?: ...;
                })[];
                id?: number;
                kind:
                    | "allow_auto_merge_when_builds_pass"
                    | "delete"
                    | "enforce_merge_checks"
                    | "force"
                    | "push"
                    | "require_all_comments_resolved"
                    | "require_all_dependencies_merged"
                    | "require_approvals_to_merge"
                    | "require_commits_behind"
                    | "require_default_reviewer_approvals_to_merge"
                    | "require_no_changes_requested"
                    | "require_passing_builds_to_merge"
                    | "require_review_group_approvals_to_merge"
                    | "require_tasks_to_be_completed"
                    | "reset_pullrequest_approvals_on_change"
                    | "reset_pullrequest_changes_requested_on_change"
                    | "restrict_merges"
                    | "smart_reset_pullrequest_approvals";
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                pattern: string;
                users?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                value?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or branch restriction id does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyid: string

        The restriction rule's id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                    value?: number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branchrestriction";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_match_kind: "branching_model" | "glob";
                        branch_type?:
                            | "bugfix"
                            | "feature"
                            | "hotfix"
                            | "release"
                            | "development"
                            | "production";
                        groups?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            full_slug?: ...;
                            links?: ...;
                            name?: ...;
                            owner?: ...;
                            slug?: ...;
                            workspace?: ...;
                        })[];
                        id?: number;
                        kind:
                            | "allow_auto_merge_when_builds_pass"
                            | "delete"
                            | "enforce_merge_checks"
                            | "force"
                            | "push"
                            | "require_all_comments_resolved"
                            | "require_all_dependencies_merged"
                            | "require_approvals_to_merge"
                            | "require_commits_behind"
                            | "require_default_reviewer_approvals_to_merge"
                            | "require_no_changes_requested"
                            | "require_passing_builds_to_merge"
                            | "require_review_group_approvals_to_merge"
                            | "require_tasks_to_be_completed"
                            | "reset_pullrequest_approvals_on_change"
                            | "reset_pullrequest_changes_requested_on_change"
                            | "restrict_merges"
                            | "smart_reset_pullrequest_approvals";
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        pattern: string;
                        users?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        value?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a branch restriction rule

    Updates an existing branch restriction rule.

    Fields not present in the request body are ignored.
    
    See [`POST`](/cloud/bitbucket/rest/api-group-branch-restrictions/#api-repositories-workspace-repo-slug-branch-restrictions-post) for details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyid: string

          The restriction rule's id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "branchrestriction";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_match_kind: "branching_model" | "glob";
                  branch_type?:
                      | "bugfix"
                      | "feature"
                      | "hotfix"
                      | "release"
                      | "development"
                      | "production";
                  groups?: readonly ({
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  })[];
                  id?: number;
                  kind:
                      | "allow_auto_merge_when_builds_pass"
                      | "delete"
                      | "enforce_merge_checks"
                      | "force"
                      | "push"
                      | "require_all_comments_resolved"
                      | "require_all_dependencies_merged"
                      | "require_approvals_to_merge"
                      | "require_commits_behind"
                      | "require_default_reviewer_approvals_to_merge"
                      | "require_no_changes_requested"
                      | "require_passing_builds_to_merge"
                      | "require_review_group_approvals_to_merge"
                      | "require_tasks_to_be_completed"
                      | "reset_pullrequest_approvals_on_change"
                      | "reset_pullrequest_changes_requested_on_change"
                      | "restrict_merges"
                      | "smart_reset_pullrequest_approvals";
                  links?: {
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  pattern: string;
                  users?: readonly ({
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
                  value?: number;
              };
          };
      }

      The new version of the existing rule

      • Readonlycontent: {
            application/json: {
                type: "branchrestriction";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_match_kind: "branching_model" | "glob";
                branch_type?:
                    | "bugfix"
                    | "feature"
                    | "hotfix"
                    | "release"
                    | "development"
                    | "production";
                groups?: readonly ({
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                })[];
                id?: number;
                kind:
                    | "allow_auto_merge_when_builds_pass"
                    | "delete"
                    | "enforce_merge_checks"
                    | "force"
                    | "push"
                    | "require_all_comments_resolved"
                    | "require_all_dependencies_merged"
                    | "require_approvals_to_merge"
                    | "require_commits_behind"
                    | "require_default_reviewer_approvals_to_merge"
                    | "require_no_changes_requested"
                    | "require_passing_builds_to_merge"
                    | "require_review_group_approvals_to_merge"
                    | "require_tasks_to_be_completed"
                    | "reset_pullrequest_approvals_on_change"
                    | "reset_pullrequest_changes_requested_on_change"
                    | "restrict_merges"
                    | "smart_reset_pullrequest_approvals";
                links?: {
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                pattern: string;
                users?: readonly ({
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
                value?: number;
            };
        }
        • Readonlyapplication/json: {
              type: "branchrestriction";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              branch_match_kind: "branching_model" | "glob";
              branch_type?:
                  | "bugfix"
                  | "feature"
                  | "hotfix"
                  | "release"
                  | "development"
                  | "production";
              groups?: readonly ({
                  type: "group";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  full_slug?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  slug?: (...) | (...);
                  workspace?: (...) | (...);
              })[];
              id?: number;
              kind:
                  | "allow_auto_merge_when_builds_pass"
                  | "delete"
                  | "enforce_merge_checks"
                  | "force"
                  | "push"
                  | "require_all_comments_resolved"
                  | "require_all_dependencies_merged"
                  | "require_approvals_to_merge"
                  | "require_commits_behind"
                  | "require_default_reviewer_approvals_to_merge"
                  | "require_no_changes_requested"
                  | "require_passing_builds_to_merge"
                  | "require_review_group_approvals_to_merge"
                  | "require_tasks_to_be_completed"
                  | "reset_pullrequest_approvals_on_change"
                  | "reset_pullrequest_changes_requested_on_change"
                  | "restrict_merges"
                  | "smart_reset_pullrequest_approvals";
              links?: {
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              pattern: string;
              users?: readonly ({
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              })[];
              value?: number;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branchrestriction";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_match_kind: "branching_model" | "glob";
                      branch_type?:
                          | "bugfix"
                          | "feature"
                          | "hotfix"
                          | "release"
                          | "development"
                          | "production";
                      groups?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          full_slug?: ...;
                          links?: ...;
                          name?: ...;
                          owner?: ...;
                          slug?: ...;
                          workspace?: ...;
                      })[];
                      id?: number;
                      kind:
                          | "allow_auto_merge_when_builds_pass"
                          | "delete"
                          | "enforce_merge_checks"
                          | "force"
                          | "push"
                          | "require_all_comments_resolved"
                          | "require_all_dependencies_merged"
                          | "require_approvals_to_merge"
                          | "require_commits_behind"
                          | "require_default_reviewer_approvals_to_merge"
                          | "require_no_changes_requested"
                          | "require_passing_builds_to_merge"
                          | "require_review_group_approvals_to_merge"
                          | "require_tasks_to_be_completed"
                          | "reset_pullrequest_approvals_on_change"
                          | "reset_pullrequest_changes_requested_on_change"
                          | "restrict_merges"
                          | "smart_reset_pullrequest_approvals";
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      pattern: string;
                      users?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      value?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branchrestriction";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_match_kind: "branching_model" | "glob";
                    branch_type?:
                        | "bugfix"
                        | "feature"
                        | "hotfix"
                        | "release"
                        | "development"
                        | "production";
                    groups?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        full_slug?: ...;
                        links?: ...;
                        name?: ...;
                        owner?: ...;
                        slug?: ...;
                        workspace?: ...;
                    })[];
                    id?: number;
                    kind:
                        | "allow_auto_merge_when_builds_pass"
                        | "delete"
                        | "enforce_merge_checks"
                        | "force"
                        | "push"
                        | "require_all_comments_resolved"
                        | "require_all_dependencies_merged"
                        | "require_approvals_to_merge"
                        | "require_commits_behind"
                        | "require_default_reviewer_approvals_to_merge"
                        | "require_no_changes_requested"
                        | "require_passing_builds_to_merge"
                        | "require_review_group_approvals_to_merge"
                        | "require_tasks_to_be_completed"
                        | "reset_pullrequest_approvals_on_change"
                        | "reset_pullrequest_changes_requested_on_change"
                        | "restrict_merges"
                        | "smart_reset_pullrequest_approvals";
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    pattern: string;
                    users?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    value?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated branch restriction rule

        • content: {
              application/json: {
                  type: "branchrestriction";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_match_kind: "branching_model" | "glob";
                  branch_type?:
                      | "bugfix"
                      | "feature"
                      | "hotfix"
                      | "release"
                      | "development"
                      | "production";
                  groups?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      full_slug?: ...;
                      links?: ...;
                      name?: ...;
                      owner?: ...;
                      slug?: ...;
                      workspace?: ...;
                  })[];
                  id?: number;
                  kind:
                      | "allow_auto_merge_when_builds_pass"
                      | "delete"
                      | "enforce_merge_checks"
                      | "force"
                      | "push"
                      | "require_all_comments_resolved"
                      | "require_all_dependencies_merged"
                      | "require_approvals_to_merge"
                      | "require_commits_behind"
                      | "require_default_reviewer_approvals_to_merge"
                      | "require_no_changes_requested"
                      | "require_passing_builds_to_merge"
                      | "require_review_group_approvals_to_merge"
                      | "require_tasks_to_be_completed"
                      | "reset_pullrequest_approvals_on_change"
                      | "reset_pullrequest_changes_requested_on_change"
                      | "restrict_merges"
                      | "smart_reset_pullrequest_approvals";
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  pattern: string;
                  users?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  value?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "branchrestriction";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_match_kind: "branching_model" | "glob";
                branch_type?:
                    | "bugfix"
                    | "feature"
                    | "hotfix"
                    | "release"
                    | "development"
                    | "production";
                groups?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    full_slug?: ...;
                    links?: ...;
                    name?: ...;
                    owner?: ...;
                    slug?: ...;
                    workspace?: ...;
                })[];
                id?: number;
                kind:
                    | "allow_auto_merge_when_builds_pass"
                    | "delete"
                    | "enforce_merge_checks"
                    | "force"
                    | "push"
                    | "require_all_comments_resolved"
                    | "require_all_dependencies_merged"
                    | "require_approvals_to_merge"
                    | "require_commits_behind"
                    | "require_default_reviewer_approvals_to_merge"
                    | "require_no_changes_requested"
                    | "require_passing_builds_to_merge"
                    | "require_review_group_approvals_to_merge"
                    | "require_tasks_to_be_completed"
                    | "reset_pullrequest_approvals_on_change"
                    | "reset_pullrequest_changes_requested_on_change"
                    | "restrict_merges"
                    | "smart_reset_pullrequest_approvals";
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                pattern: string;
                users?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                value?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or branch restriction id does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/branching-model: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the branching model for a repository

    Return the branching model as applied to the repository. This view is read-only. The branching model settings can be changed using the settings API.

    The returned object:
    
    1. Always has a `development` property. `development.branch` contains
       the actual repository branch object that is considered to be the
       `development` branch. `development.branch` will not be present
       if it does not exist.
    2. Might have a `production` property. `production` will not
       be present when `production` is disabled.
       `production.branch` contains the actual branch object that is
       considered to be the `production` branch. `production.branch` will
       not be present if it does not exist.
    3. Always has a `branch_types` array which contains all enabled branch
       types.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branching_model";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix: string;
                      }[];
                      development?: {
                          branch?: (...) & (...) & (...);
                          name: string;
                          use_mainbranch: boolean;
                      };
                      production?: {
                          branch?: (...) & (...) & (...);
                          name: string;
                          use_mainbranch: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branching_model";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix: string;
                    }[];
                    development?: {
                        branch?: (...) & (...) & (...);
                        name: string;
                        use_mainbranch: boolean;
                    };
                    production?: {
                        branch?: (...) & (...) & (...);
                        name: string;
                        use_mainbranch: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branching model object

        • content: {
              application/json: {
                  type: "branching_model";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix: string;
                  }[];
                  development?: {
                      branch?: (...) & (...) & (...);
                      name: string;
                      use_mainbranch: boolean;
                  };
                  production?: {
                      branch?: (...) & (...) & (...);
                      name: string;
                      use_mainbranch: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "branching_model";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix: string;
                }[];
                development?: {
                    branch?: (...) & (...) & (...);
                    name: string;
                    use_mainbranch: boolean;
                };
                production?: {
                    branch?: (...) & (...) & (...);
                    name: string;
                    use_mainbranch: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have read access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/branching-model/settings: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the branching model config for a repository

    Return the branching model configuration for a repository. The returned object:

    1. Always has a `development` property for the development branch.
    2. Always a `production` property for the production branch. The
       production branch can be disabled.
    3. The `branch_types` contains all the branch types.
    
    This is the raw configuration for the branching model. A client
    wishing to see the branching model with its actual current branches may
    find the [active model API](/cloud/bitbucket/rest/api-group-branching-model/#api-repositories-workspace-repo-slug-branching-model-get) more useful.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branching_model_settings";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          enabled?: (...) | (...) | (...);
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix?: (...) | (...);
                      }[];
                      development?: {
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      production?: {
                          enabled?: boolean;
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branching_model_settings";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        enabled?: (...) | (...) | (...);
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix?: (...) | (...);
                    }[];
                    development?: {
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    production?: {
                        enabled?: boolean;
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branching model configuration

        • content: {
              application/json: {
                  type: "branching_model_settings";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      enabled?: (...) | (...) | (...);
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix?: (...) | (...);
                  }[];
                  development?: {
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  production?: {
                      enabled?: boolean;
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "branching_model_settings";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    enabled?: (...) | (...) | (...);
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix?: (...) | (...);
                }[];
                development?: {
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                production?: {
                    enabled?: boolean;
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update the branching model config for a repository

    Update the branching model configuration for a repository.

    The `development` branch can be configured to a specific branch or to
    track the main branch. When set to a specific branch it must
    currently exist. Only the passed properties will be updated. The
    properties not passed will be left unchanged. A request without a
    `development` property will leave the development branch unchanged.
    
    It is possible for the `development` branch to be invalid. This
    happens when it points at a specific branch that has been
    deleted. This is indicated in the `is_valid` field for the branch. It is
    not possible to update the settings for `development` if that
    would leave the branch in an invalid state. Such a request will be
    rejected.
    
    The `production` branch can be a specific branch, the main
    branch or disabled. When set to a specific branch it must currently
    exist. The `enabled` property can be used to enable (`true`) or
    disable (`false`) it. Only the passed properties will be updated. The
    properties not passed will be left unchanged. A request without a
    `production` property will leave the production branch unchanged.
    
    It is possible for the `production` branch to be invalid. This
    happens when it points at a specific branch that has been
    deleted. This is indicated in the `is_valid` field for the branch. A
    request that would leave `production` enabled and invalid will be
    rejected. It is possible to update `production` and make it invalid if
    it would also be left disabled.
    
    The `branch_types` property contains the branch types to be updated.
    Only the branch types passed will be updated. All updates will be
    rejected if it would leave the branching model in an invalid state.
    For branch types this means that:
    
    1. The prefixes for all enabled branch types are valid. For example,
       it is not possible to use '*' inside a Git prefix.
    2. A prefix of an enabled branch type must not be a prefix of another
       enabled branch type. This is to ensure that a branch can be easily
       classified by its prefix unambiguously.
    
    It is possible to store an invalid prefix if that branch type would be
    left disabled. Only the passed properties will be updated. The
    properties not passed will be left unchanged. Each branch type must
    have a `kind` property to identify it.
    
    There is currently a side effect when using this API endpoint. If the
    repository is inheriting branching model settings from its project,
    updating the branching model for this repository will disable the
    project setting inheritance.
    
    
    We have deprecated this side effect and will remove it on 1 August 2022.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branching_model_settings";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          enabled?: (...) | (...) | (...);
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix?: (...) | (...);
                      }[];
                      development?: {
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      production?: {
                          enabled?: boolean;
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branching_model_settings";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        enabled?: (...) | (...) | (...);
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix?: (...) | (...);
                    }[];
                    development?: {
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    production?: {
                        enabled?: boolean;
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated branching model configuration

        • content: {
              application/json: {
                  type: "branching_model_settings";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      enabled?: (...) | (...) | (...);
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix?: (...) | (...);
                  }[];
                  development?: {
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  production?: {
                      enabled?: boolean;
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "branching_model_settings";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    enabled?: (...) | (...) | (...);
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix?: (...) | (...);
                }[];
                development?: {
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                production?: {
                    enabled?: boolean;
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request contains invalid branching model configuration

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a commit

    Returns the specified commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "commit";
                  } & Omit<{
                      type: "base_commit";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: (...) & (...) & (...) & (...);
                      date?: string;
                      hash?: string;
                      message?: string;
                      parents?: readonly (...)[];
                      summary?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "commit";
                } & Omit<{
                    type: "base_commit";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: (...) & (...) & (...) & (...);
                    date?: string;
                    hash?: string;
                    message?: string;
                    parents?: readonly (...)[];
                    summary?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The commit object

        • content: {
              application/json: {
                  type: "commit";
              } & Omit<{
                  type: "base_commit";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: (...) & (...) & (...) & (...);
                  date?: string;
                  hash?: string;
                  message?: string;
                  parents?: readonly (...)[];
                  summary?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "commit";
            } & Omit<{
                type: "base_commit";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: (...) & (...) & (...) & (...);
                date?: string;
                hash?: string;
                message?: string;
                parents?: readonly (...)[];
                summary?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified commit or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/approve: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Unapprove a commit

    Redact the authenticated user's approval of the specified commit.

    This operation is only available to users that have explicit access to
    the repository. In contrast, just the fact that a repository is
    publicly accessible to users does not give them the ability to approve
    commits.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response indicating the authenticated user's approval has been withdrawn.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified commit, or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Approve a commit

    Approve the specified commit as the authenticated user.

    This operation is only available to users that have explicit access to
    the repository. In contrast, just the fact that a repository is
    publicly accessible to users does not give them the ability to approve
    commits.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "participant";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      approved?: boolean;
                      participated_on?: string;
                      role?: "PARTICIPANT" | "REVIEWER";
                      state?: null | "approved" | "changes_requested";
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "participant";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    approved?: boolean;
                    participated_on?: string;
                    role?: "PARTICIPANT" | "REVIEWER";
                    state?: null | "approved" | "changes_requested";
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The participant object recording that the authenticated user approved the commit.

        • content: {
              application/json: {
                  type: "participant";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  approved?: boolean;
                  participated_on?: string;
                  role?: "PARTICIPANT" | "REVIEWER";
                  state?: null | "approved" | "changes_requested";
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "participant";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                approved?: boolean;
                participated_on?: string;
                role?: "PARTICIPANT" | "REVIEWER";
                state?: null | "approved" | "changes_requested";
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified commit, or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/comments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commit_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "commit_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    commit?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commit_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List a commit's comments

    Returns the commit's comments.

    This includes both global and inline comments.
    
    The default sorting is oldest to newest and can be overridden with
    the `sort` query parameter.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "commit_comment";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "commit_comment";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commit comments.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "commit_comment";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "commit_comment";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "commit_comment";
              } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  commit?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "commit_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    commit?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create comment for a commit

    Creates new comment on the specified commit.

    To post a reply to an existing comment, include the `parent.id` field:
    
    ```
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/db9ba1e031d07a02603eae0e559a7adc010257fc/comments/ \
      -X POST -u evzijst \
      -H 'Content-Type: application/json' \
      -d '{"content": {"raw": "One more thing!"},
           "parent": {"id": 5728901}}'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "commit_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  commit?: {
                      type: "commit";
                  } & Omit<{
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      author?: ...;
                      date?: ...;
                      hash?: ...;
                      message?: ...;
                      parents?: ...;
                      summary?: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      participants?: readonly (...)[];
                      repository?: (...) & (...) & (...) & (...);
                  };
              };
          };
      }

      The specified comment.

      • Readonlycontent: {
            application/json: {
                type: "commit_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                commit?: {
                    type: "commit";
                } & Omit<{
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    author?: ...;
                    date?: ...;
                    hash?: ...;
                    message?: ...;
                    parents?: ...;
                    summary?: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    participants?: readonly (...)[];
                    repository?: (...) & (...) & (...) & (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "commit_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              commit?: {
                  type: "commit";
              } & Omit<{
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  author?: ...;
                  date?: ...;
                  hash?: ...;
                  message?: ...;
                  parents?: ...;
                  summary?: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  participants?: readonly (...)[];
                  repository?: (...) & (...) & (...) & (...);
              };
          }
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created comment.

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly created comment.

      • Readonly400: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment was detected as spam, or if the parent comment is not attached to the same node as the new comment

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If a parent ID was passed in that cannot be found

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        commit?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "commit_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    commit?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a commit comment

    Deletes the specified commit comment.

    Note that deleting comments that have visible replies that point to
    them will not really delete the resource. This is to retain the integrity
    of the original comment tree. Instead, the `deleted` element is set to
    `true` and the content is blanked out. The comment will continue to be
    returned by the collections and self endpoints.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates the comment was deleted by this action or a previous delete.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment doesn't exist

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        commit?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a commit comment

    Returns the specified commit comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "commit_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      commit?: {
                          type: "commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          participants?: (...) | (...);
                          repository?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "commit_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    commit?: {
                        type: "commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        participants?: (...) | (...);
                        repository?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The commit comment.

        • content: {
              application/json: {
                  type: "commit_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  commit?: {
                      type: "commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      participants?: (...) | (...);
                      repository?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "commit_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                commit?: {
                    type: "commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    participants?: (...) | (...);
                    repository?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          comment_id: number;
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycomment_id: number

        The id of the comment.

      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "commit_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    commit?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a commit comment

    Used to update the contents of a comment. Only the content of the comment can be updated.

    ```
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/7f71b5/comments/5728901 \
      -X PUT -u evzijst \
      -H 'Content-Type: application/json' \
      -d '{"content": {"raw": "One more thing!"}'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "commit_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  commit?: {
                      type: "commit";
                  } & Omit<{
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      author?: ...;
                      date?: ...;
                      hash?: ...;
                      message?: ...;
                      parents?: ...;
                      summary?: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      participants?: readonly (...)[];
                      repository?: (...) & (...) & (...) & (...);
                  };
              };
          };
      }

      The updated comment.

      • Readonlycontent: {
            application/json: {
                type: "commit_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                commit?: {
                    type: "commit";
                } & Omit<{
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    author?: ...;
                    date?: ...;
                    hash?: ...;
                    message?: ...;
                    parents?: ...;
                    summary?: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    participants?: readonly (...)[];
                    repository?: (...) & (...) & (...) & (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "commit_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              commit?: {
                  type: "commit";
              } & Omit<{
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  author?: ...;
                  date?: ...;
                  hash?: ...;
                  message?: ...;
                  parents?: ...;
                  summary?: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  participants?: readonly (...)[];
                  repository?: (...) & (...) & (...) & (...);
              };
          }
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly updated comment.

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly updated comment.

      • Readonly400: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment update was detected as spam

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a commit application property

    Delete an application property value stored against a commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              commit: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            commit: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlycommit: string

          The commit.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a commit application property

    Retrieve an application property value stored against a commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              commit: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            commit: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlycommit: string

          The commit.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      _attributes?: readonly ("public" | "read_only")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The value of the property.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                commit: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a commit application property

    Update an application property value stored against a commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              commit: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            commit: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlycommit: string

          The commit.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              _attributes?: readonly ("public" | "read_only")[];
          }
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                page?: number;
                pagelen?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                page?: number;
                pagelen?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List pull requests that contain a commit

    Returns a paginated list of all pull requests as part of which this commit was reviewed. Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              page?: number;
              pagelen?: number;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The SHA1 of the commit

        • Readonlyrepo_slug: string

          The repository; either the UUID in curly braces, or the slug

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces

      • Optional Readonlyquery?: {
            page?: number;
            pagelen?: number;
        }
        • Optional Readonlypage?: number

          Which page to retrieve

        • Optional Readonlypagelen?: number

          How many pull requests to retrieve per page

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          202: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of pull requests.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  close_source_branch?: (...) | (...) | (...);
                  closed_by?: (...) | (...);
                  comment_count?: (...) | (...);
                  created_on?: (...) | (...);
                  destination?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  merge_commit?: (...) | (...);
                  participants?: (...) | (...);
                  reason?: (...) | (...);
                  rendered?: (...) | (...);
                  reviewers?: (...) | (...);
                  source?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  task_count?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly202: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository's pull requests are still being indexed.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  close_source_branch?: (...) | (...) | (...);
                  closed_by?: (...) | (...);
                  comment_count?: (...) | (...);
                  created_on?: (...) | (...);
                  destination?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  merge_commit?: (...) | (...);
                  participants?: (...) | (...);
                  reason?: (...) | (...);
                  rendered?: (...) | (...);
                  reviewers?: (...) | (...);
                  source?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  task_count?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Either the repository does not exist, or pull request commit links have not yet been indexed.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/reports: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "report";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            data?: (...) | (...);
                            details?: (...) | (...);
                            external_id?: (...) | (...);
                            link?: (...) | (...);
                            logo_url?: (...) | (...);
                            remote_link_enabled?: (...) | (...) | (...);
                            report_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            result?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "report";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            data?: (...) | (...);
                            details?: (...) | (...);
                            external_id?: (...) | (...);
                            link?: (...) | (...);
                            logo_url?: (...) | (...);
                            remote_link_enabled?: (...) | (...) | (...);
                            report_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            result?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List reports

    Returns a paginated list of Reports linked to this commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit for which to retrieve reports.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "report";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          data?: (...) | (...);
                          details?: (...) | (...);
                          external_id?: (...) | (...);
                          link?: (...) | (...);
                          logo_url?: (...) | (...);
                          remote_link_enabled?: (...) | (...) | (...);
                          report_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          result?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "report";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        data?: (...) | (...);
                        details?: (...) | (...);
                        external_id?: (...) | (...);
                        link?: (...) | (...);
                        logo_url?: (...) | (...);
                        remote_link_enabled?: (...) | (...) | (...);
                        report_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        result?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "report";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      data?: (...) | (...);
                      details?: (...) | (...);
                      external_id?: (...) | (...);
                      link?: (...) | (...);
                      logo_url?: (...) | (...);
                      remote_link_enabled?: (...) | (...) | (...);
                      report_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      result?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "report";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    data?: (...) | (...);
                    details?: (...) | (...);
                    external_id?: (...) | (...);
                    link?: (...) | (...);
                    logo_url?: (...) | (...);
                    remote_link_enabled?: (...) | (...) | (...);
                    report_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    result?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "report";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  data?: (...) | (...);
                  details?: (...) | (...);
                  external_id?: (...) | (...);
                  link?: (...) | (...);
                  logo_url?: (...) | (...);
                  remote_link_enabled?: (...) | (...) | (...);
                  report_type?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  reporter?: (...) | (...);
                  result?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        data?: readonly {
                            title?: (...) | (...);
                            type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            value?: (...) | (...);
                        }[];
                        details?: string;
                        external_id?: string;
                        link?: string;
                        logo_url?: string;
                        remote_link_enabled?: boolean;
                        report_type?:
                            | "BUG"
                            | "COVERAGE"
                            | "SECURITY"
                            | "TEST";
                        reporter?: string;
                        result?: "FAILED" | "PENDING" | "PASSED";
                        title?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "report";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    data?: readonly {
                        title?: string;
                        type?:
                            | "BOOLEAN"
                            | "DATE"
                            | "DURATION"
                            | "LINK"
                            | "NUMBER"
                            | "PERCENTAGE"
                            | "TEXT";
                        value?: Record<(...), (...)>;
                    }[];
                    details?: string;
                    external_id?: string;
                    link?: string;
                    logo_url?: string;
                    remote_link_enabled?: boolean;
                    report_type?:
                        | "BUG"
                        | "COVERAGE"
                        | "SECURITY"
                        | "TEST";
                    reporter?: string;
                    result?: "FAILED" | "PENDING" | "PASSED";
                    title?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        data?: readonly {
                            title?: (...) | (...);
                            type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            value?: (...) | (...);
                        }[];
                        details?: string;
                        external_id?: string;
                        link?: string;
                        logo_url?: string;
                        remote_link_enabled?: boolean;
                        report_type?:
                            | "BUG"
                            | "COVERAGE"
                            | "SECURITY"
                            | "TEST";
                        reporter?: string;
                        result?: "FAILED" | "PENDING" | "PASSED";
                        title?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a report

    Deletes a single Report matching the provided ID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit the report belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the report.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        No content

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        data?: readonly {
                            title?: (...) | (...);
                            type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            value?: (...) | (...);
                        }[];
                        details?: string;
                        external_id?: string;
                        link?: string;
                        logo_url?: string;
                        remote_link_enabled?: boolean;
                        report_type?:
                            | "BUG"
                            | "COVERAGE"
                            | "SECURITY"
                            | "TEST";
                        reporter?: string;
                        result?: "FAILED" | "PENDING" | "PASSED";
                        title?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a report

    Returns a single Report matching the provided ID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit the report belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the report.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "report";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      data?: readonly {
                          title?: (...) | (...);
                          type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          value?: (...) | (...);
                      }[];
                      details?: string;
                      external_id?: string;
                      link?: string;
                      logo_url?: string;
                      remote_link_enabled?: boolean;
                      report_type?:
                          | "BUG"
                          | "COVERAGE"
                          | "SECURITY"
                          | "TEST";
                      reporter?: string;
                      result?: "FAILED" | "PENDING" | "PASSED";
                      title?: string;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "report";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    data?: readonly {
                        title?: (...) | (...);
                        type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        value?: (...) | (...);
                    }[];
                    details?: string;
                    external_id?: string;
                    link?: string;
                    logo_url?: string;
                    remote_link_enabled?: boolean;
                    report_type?:
                        | "BUG"
                        | "COVERAGE"
                        | "SECURITY"
                        | "TEST";
                    reporter?: string;
                    result?: "FAILED" | "PENDING" | "PASSED";
                    title?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  type: "report";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  data?: readonly {
                      title?: (...) | (...);
                      type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      value?: (...) | (...);
                  }[];
                  details?: string;
                  external_id?: string;
                  link?: string;
                  logo_url?: string;
                  remote_link_enabled?: boolean;
                  report_type?:
                      | "BUG"
                      | "COVERAGE"
                      | "SECURITY"
                      | "TEST";
                  reporter?: string;
                  result?: "FAILED" | "PENDING" | "PASSED";
                  title?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "report";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                data?: readonly {
                    title?: (...) | (...);
                    type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    value?: (...) | (...);
                }[];
                details?: string;
                external_id?: string;
                link?: string;
                logo_url?: string;
                remote_link_enabled?: boolean;
                report_type?:
                    | "BUG"
                    | "COVERAGE"
                    | "SECURITY"
                    | "TEST";
                reporter?: string;
                result?: "FAILED" | "PENDING" | "PASSED";
                title?: string;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The report with the given ID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "report";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    data?: readonly {
                        title?: string;
                        type?:
                            | "BOOLEAN"
                            | "DATE"
                            | "DURATION"
                            | "LINK"
                            | "NUMBER"
                            | "PERCENTAGE"
                            | "TEXT";
                        value?: Record<(...), (...)>;
                    }[];
                    details?: string;
                    external_id?: string;
                    link?: string;
                    logo_url?: string;
                    remote_link_enabled?: boolean;
                    report_type?:
                        | "BUG"
                        | "COVERAGE"
                        | "SECURITY"
                        | "TEST";
                    reporter?: string;
                    result?: "FAILED" | "PENDING" | "PASSED";
                    title?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        data?: readonly {
                            title?: (...) | (...);
                            type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            value?: (...) | (...);
                        }[];
                        details?: string;
                        external_id?: string;
                        link?: string;
                        logo_url?: string;
                        remote_link_enabled?: boolean;
                        report_type?:
                            | "BUG"
                            | "COVERAGE"
                            | "SECURITY"
                            | "TEST";
                        reporter?: string;
                        result?: "FAILED" | "PENDING" | "PASSED";
                        title?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create or update a report

    Creates or updates a report for the specified commit. To upload a report, make sure to generate an ID that is unique across all reports for that commit. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-001.

    ### Sample cURL request:
    ```
    curl --request PUT 'https://api.bitbucket.org/2.0/repositories/<username>/<reposity-name>/commit/<commit-hash>/reports/mysystem-001' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "title": "Security scan report",
        "details": "This pull request introduces 10 new dependency vulnerabilities.",
        "report_type": "SECURITY",
        "reporter": "mySystem",
        "link": "http://www.mysystem.com/reports/001",
        "result": "FAILED",
        "data": [
            {
                "title": "Duration (seconds)",
                "type": "DURATION",
                "value": 14
            },
            {
                "title": "Safe to merge?",
                "type": "BOOLEAN",
                "value": false
            }
        ]
    }'
    ```
    
    ### Possible field values:
    report_type: SECURITY, COVERAGE, TEST, BUG
    result: PASSED, FAILED, PENDING
    data.type: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT
    
    #### Data field formats
    | Type  Field   | Value Field Type  | Value Field Display |
    |:--------------|:------------------|:--------------------|
    | None/ Omitted | Number, String or Boolean (not an array or object) | Plain text |
    | BOOLEAN	| Boolean | The value will be read as a JSON boolean and displayed as 'Yes' or 'No'. |
    | DATE  | Number | The value will be read as a JSON number in the form of a Unix timestamp (milliseconds) and will be displayed as a relative date if the date is less than one week ago, otherwise  it will be displayed as an absolute date. |
    | DURATION | Number | The value will be read as a JSON number in milliseconds and will be displayed in a human readable duration format. |
    | LINK | Object: `{"text": "Link text here", "href": "https://link.to.annotation/in/external/tool"}` | The value will be read as a JSON object containing the fields "text" and "href" and will be displayed as a clickable link on the report. |
    | NUMBER | Number | The value will be read as a JSON number and large numbers will be  displayed in a human readable format (e.g. 14.3k). |
    | PERCENTAGE | Number (between 0 and 100) | The value will be read as a JSON number between 0 and 100 and will be displayed with a percentage sign. |
    | TEXT | String | The value will be read as a JSON string and will be displayed as-is |
    
    Please refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit the report belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the report.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "report";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  data?: readonly {
                      title?: string;
                      type?:
                          | "BOOLEAN"
                          | "DATE"
                          | "DURATION"
                          | "LINK"
                          | "NUMBER"
                          | "PERCENTAGE"
                          | "TEXT";
                      value?: Record<(...), (...)>;
                  }[];
                  details?: string;
                  external_id?: string;
                  link?: string;
                  logo_url?: string;
                  remote_link_enabled?: boolean;
                  report_type?:
                      | "BUG"
                      | "COVERAGE"
                      | "SECURITY"
                      | "TEST";
                  reporter?: string;
                  result?: "FAILED" | "PENDING" | "PASSED";
                  title?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }

      The report to create or update

      • Readonlycontent: {
            application/json: {
                type: "report";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                data?: readonly {
                    title?: string;
                    type?:
                        | "BOOLEAN"
                        | "DATE"
                        | "DURATION"
                        | "LINK"
                        | "NUMBER"
                        | "PERCENTAGE"
                        | "TEXT";
                    value?: Record<(...), (...)>;
                }[];
                details?: string;
                external_id?: string;
                link?: string;
                logo_url?: string;
                remote_link_enabled?: boolean;
                report_type?:
                    | "BUG"
                    | "COVERAGE"
                    | "SECURITY"
                    | "TEST";
                reporter?: string;
                result?: "FAILED" | "PENDING" | "PASSED";
                title?: string;
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "report";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              data?: readonly {
                  title?: string;
                  type?:
                      | "BOOLEAN"
                      | "DATE"
                      | "DURATION"
                      | "LINK"
                      | "NUMBER"
                      | "PERCENTAGE"
                      | "TEXT";
                  value?: Record<(...), (...)>;
              }[];
              details?: string;
              external_id?: string;
              link?: string;
              logo_url?: string;
              remote_link_enabled?: boolean;
              report_type?:
                  | "BUG"
                  | "COVERAGE"
                  | "SECURITY"
                  | "TEST";
              reporter?: string;
              result?: "FAILED" | "PENDING" | "PASSED";
              title?: string;
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "report";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      data?: readonly {
                          title?: (...) | (...);
                          type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          value?: (...) | (...);
                      }[];
                      details?: string;
                      external_id?: string;
                      link?: string;
                      logo_url?: string;
                      remote_link_enabled?: boolean;
                      report_type?:
                          | "BUG"
                          | "COVERAGE"
                          | "SECURITY"
                          | "TEST";
                      reporter?: string;
                      result?: "FAILED" | "PENDING" | "PASSED";
                      title?: string;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "report";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    data?: readonly {
                        title?: (...) | (...);
                        type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        value?: (...) | (...);
                    }[];
                    details?: string;
                    external_id?: string;
                    link?: string;
                    logo_url?: string;
                    remote_link_enabled?: boolean;
                    report_type?:
                        | "BUG"
                        | "COVERAGE"
                        | "SECURITY"
                        | "TEST";
                    reporter?: string;
                    result?: "FAILED" | "PENDING" | "PASSED";
                    title?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  type: "report";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  data?: readonly {
                      title?: (...) | (...);
                      type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      value?: (...) | (...);
                  }[];
                  details?: string;
                  external_id?: string;
                  link?: string;
                  logo_url?: string;
                  remote_link_enabled?: boolean;
                  report_type?:
                      | "BUG"
                      | "COVERAGE"
                      | "SECURITY"
                      | "TEST";
                  reporter?: string;
                  result?: "FAILED" | "PENDING" | "PASSED";
                  title?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "report";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                data?: readonly {
                    title?: (...) | (...);
                    type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    value?: (...) | (...);
                }[];
                details?: string;
                external_id?: string;
                link?: string;
                logo_url?: string;
                remote_link_enabled?: boolean;
                report_type?:
                    | "BUG"
                    | "COVERAGE"
                    | "SECURITY"
                    | "TEST";
                reporter?: string;
                result?: "FAILED" | "PENDING" | "PASSED";
                title?: string;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The provided Report object is malformed or incomplete.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "report_annotation";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            annotation_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            created_on?: (...) | (...);
                            details?: (...) | (...);
                            external_id?: (...) | (...);
                            line?: (...) | (...);
                            link?: (...) | (...);
                            path?: (...) | (...);
                            result?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            severity?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: readonly ({
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                })[];
            };
        };
        responses: {
            200: {
                content: {
                    application/json: readonly ({
                        type: "report_annotation";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    })[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "report_annotation";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            annotation_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            created_on?: (...) | (...);
                            details?: (...) | (...);
                            external_id?: (...) | (...);
                            line?: (...) | (...);
                            link?: (...) | (...);
                            path?: (...) | (...);
                            result?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            severity?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List annotations

    Returns a paginated list of Annotations for a specified report.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit for which to retrieve reports.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Uuid or external-if of the report for which to get annotations for.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "report_annotation";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          annotation_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          created_on?: (...) | (...);
                          details?: (...) | (...);
                          external_id?: (...) | (...);
                          line?: (...) | (...);
                          link?: (...) | (...);
                          path?: (...) | (...);
                          result?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          severity?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "report_annotation";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        annotation_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        created_on?: (...) | (...);
                        details?: (...) | (...);
                        external_id?: (...) | (...);
                        line?: (...) | (...);
                        link?: (...) | (...);
                        path?: (...) | (...);
                        result?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        severity?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "report_annotation";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      annotation_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      created_on?: (...) | (...);
                      details?: (...) | (...);
                      external_id?: (...) | (...);
                      line?: (...) | (...);
                      link?: (...) | (...);
                      path?: (...) | (...);
                      result?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      severity?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "report_annotation";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    annotation_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    created_on?: (...) | (...);
                    details?: (...) | (...);
                    external_id?: (...) | (...);
                    line?: (...) | (...);
                    link?: (...) | (...);
                    path?: (...) | (...);
                    result?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    severity?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "report_annotation";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  annotation_type?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  created_on?: (...) | (...);
                  details?: (...) | (...);
                  external_id?: (...) | (...);
                  line?: (...) | (...);
                  link?: (...) | (...);
                  path?: (...) | (...);
                  result?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  severity?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: readonly ({
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                })[];
            };
        };
        responses: {
            200: {
                content: {
                    application/json: readonly ({
                        type: "report_annotation";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    })[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Bulk create or update annotations

    Bulk upload of annotations. Annotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.

    Add the annotations you want to upload as objects in a JSON array and make sure each annotation has the external_id field set to a unique value. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001. The external id can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). You can upload up to 100 annotations per POST request.
    
    ### Sample cURL request:
    ```
    curl --location 'https://api.bitbucket.org/2.0/repositories/<username>/<reposity-name>/commit/<commit-hash>/reports/mysystem-001/annotations' \
    --header 'Content-Type: application/json' \
    --data-raw '[
      {
            "external_id": "mysystem-annotation001",
            "title": "Security scan report",
            "annotation_type": "VULNERABILITY",
            "summary": "This line represents a security threat.",
            "severity": "HIGH",
          "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Main.java",
            "line": 42
      },
      {
            "external_id": "mySystem-annotation002",
            "title": "Bug report",
            "annotation_type": "BUG",
            "result": "FAILED",
            "summary": "This line might introduce a bug.",
            "severity": "MEDIUM",
          "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Helper.java",
            "line": 13
      }
    ]'
    ```
    
    ### Possible field values:
    annotation_type: VULNERABILITY, CODE_SMELL, BUG
    result: PASSED, FAILED, IGNORED, SKIPPED
    severity: HIGH, MEDIUM, LOW, CRITICAL
    
    Please refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit for which to retrieve reports.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Uuid or external-if of the report for which to get annotations for.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: readonly ({
                  type: "report_annotation";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                  created_on?: string;
                  details?: string;
                  external_id?: string;
                  line?: number;
                  link?: string;
                  path?: string;
                  result?:
                      | "FAILED"
                      | "PASSED"
                      | "IGNORED"
                      | "SKIPPED";
                  severity?:
                      | "CRITICAL"
                      | "HIGH"
                      | "LOW"
                      | "MEDIUM";
                  summary?: string;
                  updated_on?: string;
                  uuid?: string;
              })[];
          };
      }

      The annotations to create or update

      • Readonlycontent: {
            application/json: readonly ({
                type: "report_annotation";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                created_on?: string;
                details?: string;
                external_id?: string;
                line?: number;
                link?: string;
                path?: string;
                result?:
                    | "FAILED"
                    | "PASSED"
                    | "IGNORED"
                    | "SKIPPED";
                severity?:
                    | "CRITICAL"
                    | "HIGH"
                    | "LOW"
                    | "MEDIUM";
                summary?: string;
                updated_on?: string;
                uuid?: string;
            })[];
        }
        • Readonlyapplication/json: readonly ({
              type: "report_annotation";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
              created_on?: string;
              details?: string;
              external_id?: string;
              line?: number;
              link?: string;
              path?: string;
              result?:
                  | "FAILED"
                  | "PASSED"
                  | "IGNORED"
                  | "SKIPPED";
              severity?:
                  | "CRITICAL"
                  | "HIGH"
                  | "LOW"
                  | "MEDIUM";
              summary?: string;
              updated_on?: string;
              uuid?: string;
          })[]
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: readonly ({
                      type: "report_annotation";
                  } & Omit<Readonly<Record<(...), (...)>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                      created_on?: string;
                      details?: string;
                      external_id?: string;
                      line?: number;
                      link?: string;
                      path?: string;
                      result?:
                          | "FAILED"
                          | "PASSED"
                          | "IGNORED"
                          | "SKIPPED";
                      severity?:
                          | "CRITICAL"
                          | "HIGH"
                          | "LOW"
                          | "MEDIUM";
                      summary?: string;
                      updated_on?: string;
                      uuid?: string;
                  })[];
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: readonly ({
                    type: "report_annotation";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                })[];
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: readonly ({
                  type: "report_annotation";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                  created_on?: string;
                  details?: string;
                  external_id?: string;
                  line?: number;
                  link?: string;
                  path?: string;
                  result?:
                      | "FAILED"
                      | "PASSED"
                      | "IGNORED"
                      | "SKIPPED";
                  severity?:
                      | "CRITICAL"
                      | "HIGH"
                      | "LOW"
                      | "MEDIUM";
                  summary?: string;
                  updated_on?: string;
                  uuid?: string;
              })[];
          }
          • Readonlyapplication/json: readonly ({
                type: "report_annotation";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                created_on?: string;
                details?: string;
                external_id?: string;
                line?: number;
                link?: string;
                path?: string;
                result?:
                    | "FAILED"
                    | "PASSED"
                    | "IGNORED"
                    | "SKIPPED";
                severity?:
                    | "CRITICAL"
                    | "HIGH"
                    | "LOW"
                    | "MEDIUM";
                summary?: string;
                updated_on?: string;
                uuid?: string;
            })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an annotation

    Deletes a single Annotation matching the provided ID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              annotationId: string;
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            annotationId: string;
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • ReadonlyannotationId: string

          Either the uuid or external-id of the annotation.

        • Readonlycommit: string

          The commit the annotation belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the annotation.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        No content

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an annotation

    Returns a single Annotation matching the provided ID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              annotationId: string;
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            annotationId: string;
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • ReadonlyannotationId: string

          Either the uuid or external-id of the annotation.

        • Readonlycommit: string

          The commit the report belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the report.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "report_annotation";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                      created_on?: string;
                      details?: string;
                      external_id?: string;
                      line?: number;
                      link?: string;
                      path?: string;
                      result?:
                          | "FAILED"
                          | "PASSED"
                          | "IGNORED"
                          | "SKIPPED";
                      severity?:
                          | "CRITICAL"
                          | "HIGH"
                          | "LOW"
                          | "MEDIUM";
                      summary?: string;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  type: "report_annotation";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                  created_on?: string;
                  details?: string;
                  external_id?: string;
                  line?: number;
                  link?: string;
                  path?: string;
                  result?:
                      | "FAILED"
                      | "PASSED"
                      | "IGNORED"
                      | "SKIPPED";
                  severity?:
                      | "CRITICAL"
                      | "HIGH"
                      | "LOW"
                      | "MEDIUM";
                  summary?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "report_annotation";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                created_on?: string;
                details?: string;
                external_id?: string;
                line?: number;
                link?: string;
                path?: string;
                result?:
                    | "FAILED"
                    | "PASSED"
                    | "IGNORED"
                    | "SKIPPED";
                severity?:
                    | "CRITICAL"
                    | "HIGH"
                    | "LOW"
                    | "MEDIUM";
                summary?: string;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The annotation with the given ID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                annotationId: string;
                commit: string;
                repo_slug: string;
                reportId: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "report_annotation";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                        created_on?: string;
                        details?: string;
                        external_id?: string;
                        line?: number;
                        link?: string;
                        path?: string;
                        result?:
                            | "FAILED"
                            | "PASSED"
                            | "IGNORED"
                            | "SKIPPED";
                        severity?:
                            | "CRITICAL"
                            | "HIGH"
                            | "LOW"
                            | "MEDIUM";
                        summary?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create or update an annotation

    Creates or updates an individual annotation for the specified report. Annotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.

    Just as reports, annotation needs to be uploaded with a unique ID that can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001.
    
    ### Sample cURL request:
    ```
    curl --request PUT 'https://api.bitbucket.org/2.0/repositories/<username>/<reposity-name>/commit/<commit-hash>/reports/mySystem-001/annotations/mysystem-annotation001' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "title": "Security scan report",
        "annotation_type": "VULNERABILITY",
        "summary": "This line represents a security thread.",
        "severity": "HIGH",
        "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Main.java",
        "line": 42
    }'
    ```
    
    ### Possible field values:
    annotation_type: VULNERABILITY, CODE_SMELL, BUG
    result: PASSED, FAILED, IGNORED, SKIPPED
    severity: HIGH, MEDIUM, LOW, CRITICAL
    
    Please refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              annotationId: string;
              commit: string;
              repo_slug: string;
              reportId: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            annotationId: string;
            commit: string;
            repo_slug: string;
            reportId: string;
            workspace: string;
        }
        • ReadonlyannotationId: string

          Either the uuid or external-id of the annotation.

        • Readonlycommit: string

          The commit the report belongs to.

        • Readonlyrepo_slug: string

          The repository.

        • ReadonlyreportId: string

          Either the uuid or external-id of the report.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "report_annotation";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                  created_on?: string;
                  details?: string;
                  external_id?: string;
                  line?: number;
                  link?: string;
                  path?: string;
                  result?:
                      | "FAILED"
                      | "PASSED"
                      | "IGNORED"
                      | "SKIPPED";
                  severity?:
                      | "CRITICAL"
                      | "HIGH"
                      | "LOW"
                      | "MEDIUM";
                  summary?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }

      The annotation to create or update

      • Readonlycontent: {
            application/json: {
                type: "report_annotation";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                created_on?: string;
                details?: string;
                external_id?: string;
                line?: number;
                link?: string;
                path?: string;
                result?:
                    | "FAILED"
                    | "PASSED"
                    | "IGNORED"
                    | "SKIPPED";
                severity?:
                    | "CRITICAL"
                    | "HIGH"
                    | "LOW"
                    | "MEDIUM";
                summary?: string;
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "report_annotation";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
              created_on?: string;
              details?: string;
              external_id?: string;
              line?: number;
              link?: string;
              path?: string;
              result?:
                  | "FAILED"
                  | "PASSED"
                  | "IGNORED"
                  | "SKIPPED";
              severity?:
                  | "CRITICAL"
                  | "HIGH"
                  | "LOW"
                  | "MEDIUM";
              summary?: string;
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "report_annotation";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                      created_on?: string;
                      details?: string;
                      external_id?: string;
                      line?: number;
                      link?: string;
                      path?: string;
                      result?:
                          | "FAILED"
                          | "PASSED"
                          | "IGNORED"
                          | "SKIPPED";
                      severity?:
                          | "CRITICAL"
                          | "HIGH"
                          | "LOW"
                          | "MEDIUM";
                      summary?: string;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "report_annotation";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                    created_on?: string;
                    details?: string;
                    external_id?: string;
                    line?: number;
                    link?: string;
                    path?: string;
                    result?:
                        | "FAILED"
                        | "PASSED"
                        | "IGNORED"
                        | "SKIPPED";
                    severity?:
                        | "CRITICAL"
                        | "HIGH"
                        | "LOW"
                        | "MEDIUM";
                    summary?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        OK

        • content: {
              application/json: {
                  type: "report_annotation";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                  created_on?: string;
                  details?: string;
                  external_id?: string;
                  line?: number;
                  link?: string;
                  path?: string;
                  result?:
                      | "FAILED"
                      | "PASSED"
                      | "IGNORED"
                      | "SKIPPED";
                  severity?:
                      | "CRITICAL"
                      | "HIGH"
                      | "LOW"
                      | "MEDIUM";
                  summary?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "report_annotation";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                annotation_type?: "BUG" | "CODE_SMELL" | "VULNERABILITY";
                created_on?: string;
                details?: string;
                external_id?: string;
                line?: number;
                link?: string;
                path?: string;
                result?:
                    | "FAILED"
                    | "PASSED"
                    | "IGNORED"
                    | "SKIPPED";
                severity?:
                    | "CRITICAL"
                    | "HIGH"
                    | "LOW"
                    | "MEDIUM";
                summary?: string;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The provided Annotation object is malformed or incomplete.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                refname?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commitstatus";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            refname?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            updated_on?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                refname?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commitstatus";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            refname?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            updated_on?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commit statuses for a commit

    Returns all statuses (e.g. build results) for a specific commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              refname?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            refname?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlyrefname?: string

          If specified, only return commit status objects that were either created without a refname, or were created with the specified refname

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. Defaults to created_on.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "commitstatus";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          refname?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          updated_on?: (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "commitstatus";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        refname?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        updated_on?: (...) | (...);
                        url?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of all commit statuses for this commit.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "commitstatus";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      refname?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      updated_on?: (...) | (...);
                      url?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "commitstatus";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    refname?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    updated_on?: (...) | (...);
                    url?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "commitstatus";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  refname?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  updated_on?: (...) | (...);
                  url?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or commit does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a build status for a commit

    Creates a new build status against the specified commit.

    If the specified key already exists, the existing status object will
    be overwritten.
    
    Example:
    
    ```
    curl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/e10dae226959c2194f2b07b077c07762d93821cf/statuses/build/           -X POST -u jdoe -H 'Content-Type: application/json'           -d '{
        "key": "MY-BUILD",
        "state": "SUCCESSFUL",
        "description": "42 tests passed",
        "url": "https://www.example.org/my-build-result"
      }'
    ```
    
    When creating a new commit status, you can use a URI template for the URL.
    Templates are URLs that contain variable names that Bitbucket will
    evaluate at runtime whenever the URL is displayed anywhere similar to
    parameter substitution in
    [Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).
    For example, one could use `https://foo.com/builds/{repository.full_name}`
    which Bitbucket will turn into `https://foo.com/builds/foo/bar` at render time.
    The context variables available are `repository` and `commit`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "commitstatus";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  key?: string;
                  links?: {
                      commit?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  refname?: string;
                  state?:
                      | "FAILED"
                      | "INPROGRESS"
                      | "STOPPED"
                      | "SUCCESSFUL";
                  updated_on?: string;
                  url?: string;
                  uuid?: string;
              };
          };
      }

      The new commit status object.

      • Readonlycontent: {
            application/json: {
                type: "commitstatus";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                key?: string;
                links?: {
                    commit?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                refname?: string;
                state?:
                    | "FAILED"
                    | "INPROGRESS"
                    | "STOPPED"
                    | "SUCCESSFUL";
                updated_on?: string;
                url?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "commitstatus";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              key?: string;
              links?: {
                  commit?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              name?: string;
              refname?: string;
              state?:
                  | "FAILED"
                  | "INPROGRESS"
                  | "STOPPED"
                  | "SUCCESSFUL";
              updated_on?: string;
              url?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "commitstatus";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      key?: string;
                      links?: {
                          commit?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      refname?: string;
                      state?:
                          | "FAILED"
                          | "INPROGRESS"
                          | "STOPPED"
                          | "SUCCESSFUL";
                      updated_on?: string;
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly created build status object.

        • content: {
              application/json: {
                  type: "commitstatus";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  key?: string;
                  links?: {
                      commit?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  refname?: string;
                  state?:
                      | "FAILED"
                      | "INPROGRESS"
                      | "STOPPED"
                      | "SUCCESSFUL";
                  updated_on?: string;
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "commitstatus";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                key?: string;
                links?: {
                    commit?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                refname?: string;
                state?:
                    | "FAILED"
                    | "INPROGRESS"
                    | "STOPPED"
                    | "SUCCESSFUL";
                updated_on?: string;
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository, commit, or build status key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                key: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            key: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                key: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                key: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a build status for a commit

    Returns the specified build status for a commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              key: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            key: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlykey: string

          The build status' unique key

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "commitstatus";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      key?: string;
                      links?: {
                          commit?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      refname?: string;
                      state?:
                          | "FAILED"
                          | "INPROGRESS"
                          | "STOPPED"
                          | "SUCCESSFUL";
                      updated_on?: string;
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The build status object with the specified key.

        • content: {
              application/json: {
                  type: "commitstatus";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  key?: string;
                  links?: {
                      commit?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  refname?: string;
                  state?:
                      | "FAILED"
                      | "INPROGRESS"
                      | "STOPPED"
                      | "SUCCESSFUL";
                  updated_on?: string;
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "commitstatus";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                key?: string;
                links?: {
                    commit?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                refname?: string;
                state?:
                    | "FAILED"
                    | "INPROGRESS"
                    | "STOPPED"
                    | "SUCCESSFUL";
                updated_on?: string;
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository, commit, or build status key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            key: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          key: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlykey: string

        The build status' unique key

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                key: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commitstatus";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        key?: string;
                        links?: {
                            commit?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        refname?: string;
                        state?:
                            | "FAILED"
                            | "INPROGRESS"
                            | "STOPPED"
                            | "SUCCESSFUL";
                        updated_on?: string;
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a build status for a commit

    Used to update the current status of a build status object on the specific commit.

    This operation can also be used to change other properties of the
    build status:
    
    * `state`
    * `name`
    * `description`
    * `url`
    * `refname`
    
    The `key` cannot be changed.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              key: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            key: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlykey: string

          The build status' unique key

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "commitstatus";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  key?: string;
                  links?: {
                      commit?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  refname?: string;
                  state?:
                      | "FAILED"
                      | "INPROGRESS"
                      | "STOPPED"
                      | "SUCCESSFUL";
                  updated_on?: string;
                  url?: string;
                  uuid?: string;
              };
          };
      }

      The updated build status object

      • Readonlycontent: {
            application/json: {
                type: "commitstatus";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                key?: string;
                links?: {
                    commit?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                refname?: string;
                state?:
                    | "FAILED"
                    | "INPROGRESS"
                    | "STOPPED"
                    | "SUCCESSFUL";
                updated_on?: string;
                url?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "commitstatus";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              key?: string;
              links?: {
                  commit?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              name?: string;
              refname?: string;
              state?:
                  | "FAILED"
                  | "INPROGRESS"
                  | "STOPPED"
                  | "SUCCESSFUL";
              updated_on?: string;
              url?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "commitstatus";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      key?: string;
                      links?: {
                          commit?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      refname?: string;
                      state?:
                          | "FAILED"
                          | "INPROGRESS"
                          | "STOPPED"
                          | "SUCCESSFUL";
                      updated_on?: string;
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "commitstatus";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    key?: string;
                    links?: {
                        commit?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    refname?: string;
                    state?:
                        | "FAILED"
                        | "INPROGRESS"
                        | "STOPPED"
                        | "SUCCESSFUL";
                    updated_on?: string;
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated build status object.

        • content: {
              application/json: {
                  type: "commitstatus";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  key?: string;
                  links?: {
                      commit?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  refname?: string;
                  state?:
                      | "FAILED"
                      | "INPROGRESS"
                      | "STOPPED"
                      | "SUCCESSFUL";
                  updated_on?: string;
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "commitstatus";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                key?: string;
                links?: {
                    commit?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                refname?: string;
                state?:
                    | "FAILED"
                    | "INPROGRESS"
                    | "STOPPED"
                    | "SUCCESSFUL";
                updated_on?: string;
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or build does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commits: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits

    These are the repository's commits. They are paginated and returned in reverse chronological order, similar to the output of git log. Like these tools, the DAG can be filtered.

    #### GET /repositories/{workspace}/{repo_slug}/commits/
    
    Returns all commits in the repo in topological order (newest commit
    first). All branches and tags are included (similar to
    `git log --all`).
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master
    
    Returns all commits in the repo that are not on master
    (similar to `git log --all ^master`).
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar
    
    Returns all commits that are on refs `foo` or `bar`, but not on `fu` or
    `fubar` (similar to `git log foo bar ^fu ^fubar`).
    
    An optional `path` parameter can be specified that will limit the
    results to commits that affect that path. `path` can either be a file
    or a directory. If a directory is specified, commits are returned that
    have modified any file in the directory tree rooted by `path`. It is
    important to note that if the `path` parameter is specified, the commits
    returned by this endpoint may no longer be a DAG, parent commits that
    do not modify the path will be omitted from the response.
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master
    
    Returns all commits that are on refs `foo` or `bar`, but not on `master`
    that changed the file README.md.
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master
    
    Returns all commits that are on refs `foo` or `bar`, but not on `master`
    that changed to a file in any file in the directory src or its children.
    
    Because the response could include a very large number of commits, it
    is paginated. Follow the 'next' link in the response to navigate to the
    next page of commits. As with other paginated resources, do not
    construct your own links.
    
    When the include and exclude parameters are more than can fit in a
    query string, clients can use a `x-www-form-urlencoded` POST instead.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "base_commit";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          date?: (...) | (...);
                          hash?: (...) | (...);
                          message?: (...) | (...);
                          parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                          summary?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "base_commit";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        date?: (...) | (...);
                        hash?: (...) | (...);
                        message?: (...) | (...);
                        parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                        summary?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "base_commit";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      date?: (...) | (...);
                      hash?: (...) | (...);
                      message?: (...) | (...);
                      parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                      summary?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "base_commit";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    date?: (...) | (...);
                    hash?: (...) | (...);
                    message?: (...) | (...);
                    parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                    summary?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "base_commit";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  date?: (...) | (...);
                  hash?: (...) | (...);
                  message?: (...) | (...);
                  parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                  summary?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits with include/exclude

    Identical to GET /repositories/{workspace}/{repo_slug}/commits, except that POST allows clients to place the include and exclude parameters in the request body to avoid URL length issues.

    **Note that this resource does NOT support new commit creation.**
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "base_commit";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          date?: (...) | (...);
                          hash?: (...) | (...);
                          message?: (...) | (...);
                          parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                          summary?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "base_commit";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        date?: (...) | (...);
                        hash?: (...) | (...);
                        message?: (...) | (...);
                        parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                        summary?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "base_commit";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      date?: (...) | (...);
                      hash?: (...) | (...);
                      message?: (...) | (...);
                      parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                      summary?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "base_commit";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    date?: (...) | (...);
                    hash?: (...) | (...);
                    message?: (...) | (...);
                    parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                    summary?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "base_commit";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  date?: (...) | (...);
                  hash?: (...) | (...);
                  message?: (...) | (...);
                  parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                  summary?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/commits/{revision}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits for revision

    These are the repository's commits. They are paginated and returned in reverse chronological order, similar to the output of git log. Like these tools, the DAG can be filtered.

    #### GET /repositories/{workspace}/{repo_slug}/commits/master
    
    Returns all commits on ref `master` (similar to `git log master`).
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/dev?include=foo&exclude=master
    
    Returns all commits on ref `dev` or `foo`, except those that are reachable on
    `master` (similar to `git log dev foo ^master`).
    
    An optional `path` parameter can be specified that will limit the
    results to commits that affect that path. `path` can either be a file
    or a directory. If a directory is specified, commits are returned that
    have modified any file in the directory tree rooted by `path`. It is
    important to note that if the `path` parameter is specified, the commits
    returned by this endpoint may no longer be a DAG, parent commits that
    do not modify the path will be omitted from the response.
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=README.md&include=foo&include=bar&exclude=master
    
    Returns all commits that are on refs `dev` or `foo` or `bar`, but not on `master`
    that changed the file README.md.
    
    #### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=src/&include=foo&exclude=master
    
    Returns all commits that are on refs `dev` or `foo`, but not on `master`
    that changed to a file in any file in the directory src or its children.
    
    Because the response could include a very large number of commits, it
    is paginated. Follow the 'next' link in the response to navigate to the
    next page of commits. As with other paginated resources, do not
    construct your own links.
    
    When the include and exclude parameters are more than can fit in a
    query string, clients can use a `x-www-form-urlencoded` POST instead.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              revision: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            revision: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyrevision: string

          A commit SHA1 or ref name.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "base_commit";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          date?: (...) | (...);
                          hash?: (...) | (...);
                          message?: (...) | (...);
                          parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                          summary?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "base_commit";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        date?: (...) | (...);
                        hash?: (...) | (...);
                        message?: (...) | (...);
                        parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                        summary?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "base_commit";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      date?: (...) | (...);
                      hash?: (...) | (...);
                      message?: (...) | (...);
                      parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                      summary?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "base_commit";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    date?: (...) | (...);
                    hash?: (...) | (...);
                    message?: (...) | (...);
                    parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                    summary?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "base_commit";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  date?: (...) | (...);
                  hash?: (...) | (...);
                  message?: (...) | (...);
                  parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                  summary?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified revision does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          revision: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyrevision: string

        A commit SHA1 or ref name.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "base_commit";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            date?: (...) | (...);
                            hash?: (...) | (...);
                            message?: (...) | (...);
                            parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                            summary?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits for revision using include/exclude

    Identical to GET /repositories/{workspace}/{repo_slug}/commits/{revision}, except that POST allows clients to place the include and exclude parameters in the request body to avoid URL length issues.

    **Note that this resource does NOT support new commit creation.**
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              revision: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            revision: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyrevision: string

          A commit SHA1 or ref name.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "base_commit";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          date?: (...) | (...);
                          hash?: (...) | (...);
                          message?: (...) | (...);
                          parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                          summary?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "base_commit";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        date?: (...) | (...);
                        hash?: (...) | (...);
                        message?: (...) | (...);
                        parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                        summary?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "base_commit";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      date?: (...) | (...);
                      hash?: (...) | (...);
                      message?: (...) | (...);
                      parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                      summary?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "base_commit";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    date?: (...) | (...);
                    hash?: (...) | (...);
                    message?: (...) | (...);
                    parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                    summary?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "base_commit";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  date?: (...) | (...);
                  hash?: (...) | (...);
                  message?: (...) | (...);
                  parents?: readonly ({ readonly type: "base_commit"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; })[] | undefined;
                  summary?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified revision does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/components: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List components

    Returns the components that have been defined in the issue tracker.

    This resource is only available on repositories that have the issue
    tracker enabled.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "component";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "component";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The components that have been defined in the issue tracker.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "component";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "component";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "component";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  id?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/components/{component_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                component_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "component";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            component_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                component_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "component";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a component for issues

    Returns the specified issue tracker component object.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              component_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            component_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomponent_id: number

          The component's id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "component";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "component";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified component object.

        • content: {
              application/json: {
                  type: "component";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "component";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                id?: number;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or component does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            component_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          component_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycomponent_id: number

        The component's id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/default-reviewers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List default reviewers

    Returns the repository's default reviewers.

    These are the users that are automatically added as reviewers on every
    new pull request that is created. To obtain the repository's default reviewers
    as well as the default reviewers inherited from the project, use the
    [effective-default-reveiwers](#api-repositories-workspace-repo-slug-effective-default-reviewers-get) endpoint.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of default reviewers

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to view the default reviewers

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            target_username: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Remove a user from the default reviewers

    Removes a default reviewer from the repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              target_username: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            target_username: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytarget_username: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user successfully removed from the default reviewers

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access modify the default reviewers

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a default reviewer

    Returns the specified reviewer.

    This can be used to test whether a user is among the repository's
    default reviewers list. A 404 indicates that that specified user is not
    a default reviewer.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              target_username: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            target_username: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytarget_username: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "account";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "account";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user is a default reviewer

        • content: {
              application/json: {
                  type: "account";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "account";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to check if the specified user is a default reviewer

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist or is not a default reviewer

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            target_username: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          target_username: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlytarget_username: string

        This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                target_username: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Add a user to the default reviewers

    Adds the specified user to the repository's list of default reviewers.

    This method is idempotent. Adding a user a second time has no effect.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              target_username: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            target_username: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytarget_username: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "account";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "account";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user was successfully added to the default reviewers

        • content: {
              application/json: {
                  type: "account";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "account";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user tried to add a team, bot user, or user without access to the repository to the default reviewers

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to modify the default reviewers

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deploy-keys: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deploy_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            added_on?: (...) | (...);
                            comment?: (...) | (...);
                            key?: (...) | (...);
                            label?: (...) | (...);
                            last_used?: (...) | (...);
                            links?: (...) | (...);
                            owner?: (...) | (...);
                            repository?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deploy_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            added_on?: (...) | (...);
                            comment?: (...) | (...);
                            key?: (...) | (...);
                            label?: (...) | (...);
                            last_used?: (...) | (...);
                            links?: (...) | (...);
                            owner?: (...) | (...);
                            repository?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List repository deploy keys

    Returns all deploy-keys belonging to a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "deploy_key";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          added_on?: (...) | (...);
                          comment?: (...) | (...);
                          key?: (...) | (...);
                          label?: (...) | (...);
                          last_used?: (...) | (...);
                          links?: (...) | (...);
                          owner?: (...) | (...);
                          repository?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "deploy_key";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        added_on?: (...) | (...);
                        comment?: (...) | (...);
                        key?: (...) | (...);
                        label?: (...) | (...);
                        last_used?: (...) | (...);
                        links?: (...) | (...);
                        owner?: (...) | (...);
                        repository?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Deploy keys matching the repository

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "deploy_key";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      added_on?: (...) | (...);
                      comment?: (...) | (...);
                      key?: (...) | (...);
                      label?: (...) | (...);
                      last_used?: (...) | (...);
                      links?: (...) | (...);
                      owner?: (...) | (...);
                      repository?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "deploy_key";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    added_on?: (...) | (...);
                    comment?: (...) | (...);
                    key?: (...) | (...);
                    label?: (...) | (...);
                    last_used?: (...) | (...);
                    links?: (...) | (...);
                    owner?: (...) | (...);
                    repository?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "deploy_key";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  added_on?: (...) | (...);
                  comment?: (...) | (...);
                  key?: (...) | (...);
                  label?: (...) | (...);
                  last_used?: (...) | (...);
                  links?: (...) | (...);
                  owner?: (...) | (...);
                  repository?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository is not accessible to the current user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Add a repository deploy key

    Create a new deploy key in a repository. Note: If authenticating a deploy key with an OAuth consumer, any changes to the OAuth consumer will subsequently invalidate the deploy key.

    Example:
    ```
    $ curl -X POST \
    -H "Authorization <auth header>" \
    -H "Content-type: application/json" \
    https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys -d \
    '{
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8",
        "label": "mydeploykey"
    }'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deploy_key";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      added_on?: string;
                      comment?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deploy_key";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    added_on?: string;
                    comment?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The deploy key that was created

        • content: {
              application/json: {
                  type: "deploy_key";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  added_on?: string;
                  comment?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "deploy_key";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                added_on?: string;
                comment?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Invalid deploy key inputs

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository is not accessible to the current user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a repository deploy key

    This deletes a deploy key from a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlykey_id: string

          The key ID matching the deploy key.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The key has been deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to delete a key for the specified user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user, repository, or deploy key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a repository deploy key

    Returns the deploy key belonging to a specific key.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlykey_id: string

          The key ID matching the deploy key.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deploy_key";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      added_on?: string;
                      comment?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deploy_key";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    added_on?: string;
                    comment?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Deploy key matching the key ID

        • content: {
              application/json: {
                  type: "deploy_key";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  added_on?: string;
                  comment?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "deploy_key";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                added_on?: string;
                comment?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository is not accessible to the current user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          key_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlykey_id: string

        The key ID matching the deploy key.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a repository deploy key

    Create a new deploy key in a repository.

    The same key needs to be passed in but the comment and label can change.
    
    Example:
    ```
    $ curl -X PUT \
    -H "Authorization <auth header>" \
    -H "Content-type: application/json" \
    https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234 -d \
    '{
        "label": "newlabel",
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 newcomment",
    }'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlykey_id: string

          The key ID matching the deploy key.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deploy_key";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      added_on?: string;
                      comment?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deploy_key";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    added_on?: string;
                    comment?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly updated deploy key.

        • content: {
              application/json: {
                  type: "deploy_key";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  added_on?: string;
                  comment?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "deploy_key";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                added_on?: string;
                comment?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the submitted key or related value is invalid

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to add a key for the specified user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user, repository, or deploy key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deployments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            environment?: (...) | (...);
                            release?: (...) | (...);
                            state?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            environment?: (...) | (...);
                            release?: (...) | (...);
                            state?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List deployments

    Find deployments

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "deployment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          environment?: (...) | (...);
                          release?: (...) | (...);
                          state?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "deployment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        environment?: (...) | (...);
                        release?: (...) | (...);
                        state?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The matching deployments.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "deployment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      environment?: (...) | (...);
                      release?: (...) | (...);
                      state?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "deployment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    environment?: (...) | (...);
                    release?: (...) | (...);
                    state?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "deployment";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  environment?: (...) | (...);
                  release?: (...) | (...);
                  state?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List variables for an environment

    Find deployment environment level variables.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "deployment_variable";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          secured?: (...) | (...) | (...);
                          uuid?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "deployment_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The retrieved deployment variables.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "deployment_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "deployment_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "deployment_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a variable for an environment

    Create a deployment environment level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "deployment_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }

      The variable to create

      • Readonlycontent: {
            application/json: {
                type: "deployment_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "deployment_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "deployment_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The variable was created.

        • content: {
              application/json: {
                  type: "deployment_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "deployment_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created variable.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository, environment or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A variable with the provided key already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a variable for an environment

    Delete a deployment environment level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyvariable_uuid: string

          The UUID of the variable to delete.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository, environment or variable with given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a variable for an environment

    Update a deployment environment level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyvariable_uuid: string

          The UUID of the variable to update.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "deployment_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }

      The updated deployment variable.

      • Readonlycontent: {
            application/json: {
                type: "deployment_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "deployment_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deployment_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deployment_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The deployment variable was updated.

        • content: {
              application/json: {
                  type: "deployment_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "deployment_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository, environment or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                deployment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        environment?: {
                            type: "deployment_environment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            name?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        release?: {
                            type: "deployment_release";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            created_on?: (...) | (...);
                            name?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "deployment_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                deployment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        environment?: {
                            type: "deployment_environment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            name?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        release?: {
                            type: "deployment_release";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            created_on?: (...) | (...);
                            name?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "deployment_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a deployment

    Retrieve a deployment

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              deployment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            deployment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlydeployment_uuid: string

          The deployment UUID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deployment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      environment?: {
                          type: "deployment_environment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          name?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      release?: {
                          type: "deployment_release";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          created_on?: (...) | (...);
                          name?: (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?: {
                          type: "deployment_state";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deployment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    environment?: {
                        type: "deployment_environment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        name?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    release?: {
                        type: "deployment_release";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        created_on?: (...) | (...);
                        name?: (...) | (...);
                        url?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?: {
                        type: "deployment_state";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The deployment.

        • content: {
              application/json: {
                  type: "deployment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  environment?: {
                      type: "deployment_environment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      name?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  release?: {
                      type: "deployment_release";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      created_on?: (...) | (...);
                      name?: (...) | (...);
                      url?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?: {
                      type: "deployment_state";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "deployment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                environment?: {
                    type: "deployment_environment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    name?: (...) | (...);
                    uuid?: (...) | (...);
                };
                release?: {
                    type: "deployment_release";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    created_on?: (...) | (...);
                    name?: (...) | (...);
                    url?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?: {
                    type: "deployment_state";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository or deployment with the UUID provided exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/diff/{spec}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: {
                binary?: boolean;
                context?: number;
                ignore_whitespace?: boolean;
                merge?: boolean;
                path?: string;
                renames?: boolean;
                topic?: boolean;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: {
                binary?: boolean;
                context?: number;
                ignore_whitespace?: boolean;
                merge?: boolean;
                path?: string;
                renames?: boolean;
                topic?: boolean;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Compare two commits

    Produces a raw git-style diff.

    #### Single commit spec
    
    If the `spec` argument to this API is a single commit, the diff is
    produced against the first parent of the specified commit.
    
    #### Two commit spec
    
    Two commits separated by `..` may be provided as the `spec`, e.g.,
    `3a8b42..9ff173`. When two commits are provided and the `topic` query
    parameter is true, this API produces a 2-way three dot diff.
    This is the diff between source commit and the merge base of the source
    commit and the destination commit. When the `topic` query param is false,
    a simple git-style diff is produced.
    
    The two commits are interpreted as follows:
    
    * First commit: the commit containing the changes we wish to preview
    * Second commit: the commit representing the state to which we want to
      compare the first commit
    * **Note**: This is the opposite of the order used in `git diff`.
    
    #### Comparison to patches
    
    While similar to patches, diffs:
    
    * Don't have a commit header (username, commit message, etc)
    * Support the optional `path=foo/bar.py` query param to filter
      the diff to just that one file diff
    
    #### Response
    
    The raw diff is returned as-is, in whatever encoding the files in the
    repository use. It is not decoded into unicode. As such, the
    content-type is `text/plain`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              spec: string;
              workspace: string;
          };
          query?: {
              binary?: boolean;
              context?: number;
              ignore_whitespace?: boolean;
              merge?: boolean;
              path?: string;
              renames?: boolean;
              topic?: boolean;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            spec: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyspec: string

          A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            binary?: boolean;
            context?: number;
            ignore_whitespace?: boolean;
            merge?: boolean;
            path?: string;
            renames?: boolean;
            topic?: boolean;
        }
        • Optional Readonlybinary?: boolean

          Generate diffs that include binary files, true if omitted.

        • Optional Readonlycontext?: number

          Generate diffs with lines of context instead of the usual three.

        • Optional Readonlyignore_whitespace?: boolean

          Generate diffs that ignore whitespace.

        • Optional Readonlymerge?: boolean

          This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time.

          If true, the source commit is merged into the
          destination commit, and then a diff from the
          destination to the merge result is returned. If false,
          a simple 'two dot' diff between the source and
          destination is returned. True if omitted.
          
        • Optional Readonlypath?: string

          Limit the diff to a particular file (this parameter can be repeated for multiple paths).

        • Optional Readonlyrenames?: boolean

          Whether to perform rename detection, true if omitted.

        • Optional Readonlytopic?: boolean

          If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw diff

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the diff was too large and timed out.

        Since this endpoint does not employ any form of pagination, but
        instead returns the diff as a single document, it can run into
        trouble on very large diffs. If Bitbucket times out in cases
        like these, a 555 status code is returned.
        
        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          spec: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyspec: string

        A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/diffstat/{spec}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: {
                ignore_whitespace?: boolean;
                merge?: boolean;
                path?: string;
                renames?: boolean;
                topic?: boolean;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            lines_added?: (...) | (...);
                            lines_removed?: (...) | (...);
                            new?: (...) | (...);
                            old?: (...) | (...);
                            status?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: {
            ignore_whitespace?: boolean;
            merge?: boolean;
            path?: string;
            renames?: boolean;
            topic?: boolean;
        };
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: {
                ignore_whitespace?: boolean;
                merge?: boolean;
                path?: string;
                renames?: boolean;
                topic?: boolean;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            lines_added?: (...) | (...);
                            lines_removed?: (...) | (...);
                            new?: (...) | (...);
                            old?: (...) | (...);
                            status?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Compare two commit diff stats

    Produces a response in JSON format with a record for every path modified, including information on the type of the change and the number of lines added and removed.

    #### Single commit spec
    
    If the `spec` argument to this API is a single commit, the diff is
    produced against the first parent of the specified commit.
    
    #### Two commit spec
    
    Two commits separated by `..` may be provided as the `spec`, e.g.,
    `3a8b42..9ff173`. When two commits are provided and the `topic` query
    parameter is true, this API produces a 2-way three dot diff.
    This is the diff between source commit and the merge base of the source
    commit and the destination commit. When the `topic` query param is false,
    a simple git-style diff is produced.
    
    The two commits are interpreted as follows:
    
    * First commit: the commit containing the changes we wish to preview
    * Second commit: the commit representing the state to which we want to
      compare the first commit
    * **Note**: This is the opposite of the order used in `git diff`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              spec: string;
              workspace: string;
          };
          query?: {
              ignore_whitespace?: boolean;
              merge?: boolean;
              path?: string;
              renames?: boolean;
              topic?: boolean;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            spec: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyspec: string

          A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            ignore_whitespace?: boolean;
            merge?: boolean;
            path?: string;
            renames?: boolean;
            topic?: boolean;
        }
        • Optional Readonlyignore_whitespace?: boolean

          Generate diffs that ignore whitespace

        • Optional Readonlymerge?: boolean

          This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time.

          If true, the source commit is merged into the
          destination commit, and then a diffstat from the
          destination to the merge result is returned. If false,
          a simple 'two dot' diffstat between the source and
          destination is returned. True if omitted.
          
        • Optional Readonlypath?: string

          Limit the diffstat to a particular file (this parameter can be repeated for multiple paths).

        • Optional Readonlyrenames?: boolean

          Whether to perform rename detection, true if omitted.

        • Optional Readonlytopic?: boolean

          If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          lines_added?: (...) | (...);
                          lines_removed?: (...) | (...);
                          new?: (...) | (...);
                          old?: (...) | (...);
                          status?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        lines_added?: (...) | (...);
                        lines_removed?: (...) | (...);
                        new?: (...) | (...);
                        old?: (...) | (...);
                        status?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The diff stats

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      lines_added?: (...) | (...);
                      lines_removed?: (...) | (...);
                      new?: (...) | (...);
                      old?: (...) | (...);
                      status?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    lines_added?: (...) | (...);
                    lines_removed?: (...) | (...);
                    new?: (...) | (...);
                    old?: (...) | (...);
                    status?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 500 with 5000 being the maximum allowed value.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  lines_added?: (...) | (...);
                  lines_removed?: (...) | (...);
                  new?: (...) | (...);
                  old?: (...) | (...);
                  status?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If generating the diffstat timed out.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: {
            ignore_whitespace?: boolean;
            merge?: boolean;
            path?: string;
            renames?: boolean;
            topic?: boolean;
        };
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          spec: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyspec: string

        A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: {
          ignore_whitespace?: boolean;
          merge?: boolean;
          path?: string;
          renames?: boolean;
          topic?: boolean;
      }
      • Optional Readonlyignore_whitespace?: boolean

        Generate diffs that ignore whitespace

      • Optional Readonlymerge?: boolean

        This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time.

        If true, the source commit is merged into the
        destination commit, and then a diffstat from the
        destination to the merge result is returned. If false,
        a simple 'two dot' diffstat between the source and
        destination is returned. True if omitted.
        
      • Optional Readonlypath?: string

        Limit the diffstat to a particular file (this parameter can be repeated for multiple paths).

      • Optional Readonlyrenames?: boolean

        Whether to perform rename detection, true if omitted.

      • Optional Readonlytopic?: boolean

        If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned.

  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/downloads: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            406: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List download artifacts

    Returns a list of download links associated with the repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Returns a paginated list of the downloads associated with the repository.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        User is not authorized to read from the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            406: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Upload a download artifact

    Upload new download artifacts.

    To upload files, perform a `multipart/form-data` POST containing one
    or more `files` fields:
    
        $ echo Hello World > hello.txt
        $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt
    
    When a file is uploaded with the same name as an existing artifact,
    then the existing file will be replaced.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          406: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The artifact was uploaded sucessfully.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Bad Request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        User is not authorized to write to the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly406: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Unsupported Content-Type. Use multiplart/form-data.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/downloads/{filename}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                filename: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                filename: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            filename: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                filename: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a download artifact

    Deletes the specified download artifact from the repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              filename: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            filename: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyfilename: string

          Name of the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The specified download artifact was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        User is not authorized to write to the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified download does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                filename: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a download artifact link

    Return a redirect to the contents of a download artifact.

    This endpoint returns the actual file contents and not the artifact's
    metadata.
    
        $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt
        Hello World
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              filename: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            filename: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyfilename: string

          Name of the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Redirects to the url of the specified download artifact.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        User is not authorized to read from the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified download artifact does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            filename: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          filename: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyfilename: string

        Name of the file.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/effective-branching-model: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "effective_repo_branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "effective_repo_branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            branch?: (...) & (...) & (...);
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the effective, or currently applied, branching model for a repository

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "effective_repo_branching_model";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix: string;
                      }[];
                      development?: {
                          branch?: (...) & (...) & (...);
                          name: string;
                          use_mainbranch: boolean;
                      };
                      production?: {
                          branch?: (...) & (...) & (...);
                          name: string;
                          use_mainbranch: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "effective_repo_branching_model";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix: string;
                    }[];
                    development?: {
                        branch?: (...) & (...) & (...);
                        name: string;
                        use_mainbranch: boolean;
                    };
                    production?: {
                        branch?: (...) & (...) & (...);
                        name: string;
                        use_mainbranch: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The effective branching model object

        • content: {
              application/json: {
                  type: "effective_repo_branching_model";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix: string;
                  }[];
                  development?: {
                      branch?: (...) & (...) & (...);
                      name: string;
                      use_mainbranch: boolean;
                  };
                  production?: {
                      branch?: (...) & (...) & (...);
                      name: string;
                      use_mainbranch: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "effective_repo_branching_model";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix: string;
                }[];
                development?: {
                    branch?: (...) & (...) & (...);
                    name: string;
                    use_mainbranch: boolean;
                };
                production?: {
                    branch?: (...) & (...) & (...);
                    name: string;
                    use_mainbranch: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have read access to the repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/effective-default-reviewers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            reviewer_type?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            reviewer_type?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List effective default reviewers

    Returns the repository's effective default reviewers. This includes both default reviewers defined at the repository level as well as those inherited from its project.

    These are the users that are automatically added as reviewers on every
    new pull request that is created.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          reviewer_type?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        reviewer_type?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of effective default reviewers

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      reviewer_type?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    reviewer_type?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  reviewer_type?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to view the default reviewers

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/environments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment_environment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            name?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_environment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    name?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "deployment_environment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        name?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "deployment_environment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            name?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List environments

    Find environments

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "deployment_environment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          name?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "deployment_environment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        name?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The matching environments.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "deployment_environment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      name?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "deployment_environment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    name?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "deployment_environment";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  name?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "deployment_environment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    name?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "deployment_environment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        name?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create an environment

    Create an environment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "deployment_environment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  name?: string;
                  uuid?: string;
              };
          };
      }

      The environment to create.

      • Readonlycontent: {
            application/json: {
                type: "deployment_environment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                name?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "deployment_environment";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              name?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "deployment_environment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      name?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "deployment_environment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    name?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The environment was created.

        • content: {
              application/json: {
                  type: "deployment_environment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  name?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "deployment_environment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                name?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created environment.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        An environment host with the provided name already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment_environment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        name?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an environment

    Delete an environment

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment UUID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The environment was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account or repository with the UUID provided exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "deployment_environment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        name?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an environment

    Retrieve an environment

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment UUID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "deployment_environment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      name?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "deployment_environment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    name?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The environment.

        • content: {
              application/json: {
                  type: "deployment_environment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  name?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "deployment_environment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                name?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository or environment with the UUID provided exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes: {
    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: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                environment_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an environment

    Update an environment

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              environment_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            environment_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyenvironment_uuid: string

          The environment UUID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          202: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly202: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The environment update request was accepted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository or environment with the UUID provided exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                renames?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            attributes?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            commit?: (...) | (...);
                            escaped_path?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                renames?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            attributes?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            commit?: (...) | (...);
                            escaped_path?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits that modified a file

    Returns a paginated list of commits that modified the specified file.

    Commits are returned in reverse chronological order. This is roughly
    equivalent to the following commands:
    
        $ git log --follow --date-order <sha> <path>
    
    By default, Bitbucket will follow renames and the path name in the
    returned entries reflects that. This can be turned off using the
    `?renames=false` query parameter.
    
    Results are returned in descending chronological order by default, and
    like most endpoints you can
    [filter and sort](/cloud/bitbucket/rest/intro/#filtering) the response to
    only provide exactly the data you want.
    
    The example response returns commits made before 2011-05-18 against a file
    named `README.rst`. The results are filtered to only return the path and
    date. This request can be made using:
    
    ```
    $ curl 'https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/filehistory/master/README.rst'\
      '?fields=values.next,values.path,values.commit.date&q=commit.date<=2011-05-18'
    ```
    
    In the response you can see that the file was renamed to `README.rst`
    by the commit made on 2011-05-16, and was previously named `README.txt`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              path: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              renames?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlypath: string

          Path to the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            renames?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlyrenames?: string

          When true, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying false.

        • Optional Readonlysort?: string

          Name of a response property sort the result by as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          attributes?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          commit?: (...) | (...);
                          escaped_path?: (...) | (...);
                          path?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        attributes?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        commit?: (...) | (...);
                        escaped_path?: (...) | (...);
                        path?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits that modified the specified file

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      attributes?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      commit?: (...) | (...);
                      escaped_path?: (...) | (...);
                      path?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    attributes?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    commit?: (...) | (...);
                    escaped_path?: (...) | (...);
                    path?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  attributes?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  commit?: (...) | (...);
                  escaped_path?: (...) | (...);
                  path?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          path: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlypath: string

        Path to the file.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/forks: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                role?:
                    | "admin"
                    | "contributor"
                    | "member"
                    | "owner";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: (...) | (...);
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List repository forks

    Returns a paginated list of all the forks of the specified repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              role?:
                  | "admin"
                  | "contributor"
                  | "member"
                  | "owner";
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            role?:
                | "admin"
                | "contributor"
                | "member"
                | "owner";
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlyrole?:
              | "admin"
              | "contributor"
              | "member"
              | "owner"

          Filters the result based on the authenticated user's role on each repository.

          * **member**: returns repositories to which the user has explicit read access
          * **contributor**: returns repositories to which the user has explicit write access
          * **admin**: returns repositories to which the user has explicit administrator access
          * **owner**: returns all repositories owned by the current user
          
        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: (...) | (...);
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: (...) | (...);
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All forks.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: (...) | (...);
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: (...) | (...);
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "repository";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  fork_policy?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  full_name?: (...) | (...);
                  has_issues?: (...) | (...) | (...);
                  has_wiki?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  language?: (...) | (...);
                  links?: (...) | (...);
                  mainbranch?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  parent?: (...) | (...);
                  project?: (...) | (...);
                  scm?: (...) | (...);
                  size?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "repository";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            clone?: readonly (...)[];
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            downloads?: {
                                href?: ...;
                                name?: ...;
                            };
                            forks?: {
                                href?: ...;
                                name?: ...;
                            };
                            hooks?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            pullrequests?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            watchers?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        mainbranch?: Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        };
                        name?: string;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
        };
    }

    Fork a repository

    Creates a new fork of the specified repository.

    #### Forking a repository
    
    To create a fork, specify the workspace explicitly as part of the
    request body:
    
    ```
    $ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/atlassian/bbql/forks \
      -H 'Content-Type: application/json' -d '{
        "name": "bbql_fork",
        "workspace": {
          "slug": "atlassian"
        }
    }'
    ```
    
    To fork a repository into the same workspace, also specify a new `name`.
    
    When you specify a value for `name`, it will also affect the `slug`.
    The `slug` is reflected in the repository URL of the new fork. It is
    derived from `name` by substituting non-ASCII characters, removes
    whitespace, and changes characters to lower case. For example,
    `My repo` would turn into `my_repo`.
    
    You need contributor access to create new forks within a workspace.
    
    
    #### Change the properties of a new fork
    
    By default the fork inherits most of its properties from the parent.
    However, since the optional POST body document follows the normal
    `repository` JSON schema and you can override the new fork's
    properties.
    
    Properties that can be overridden include:
    
    * description
    * fork_policy
    * language
    * mainbranch
    * is_private (note that a private repo's fork_policy might prohibit
      the creation of public forks, in which `is_private=False` would fail)
    * has_issues (to initialize or disable the new repo's issue tracker --
      note that the actual contents of the parent repository's issue
      tracker are not copied during forking)
    * has_wiki (to initialize or disable the new repo's wiki --
      note that the actual contents of the parent repository's wiki are not
      copied during forking)
    * project (when forking into a private project, the fork's `is_private`
      must be `true`)
    
    Properties that cannot be modified include:
    
    * scm
    * parent
    * full_name
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }

      A repository object. This can be left blank.

      • Readonlycontent: {
            application/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "repository";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
              full_name?: string;
              has_issues?: boolean;
              has_wiki?: boolean;
              is_private?: boolean;
              language?: string;
              links?: {
                  avatar?: {
                      href?: ...;
                      name?: ...;
                  };
                  clone?: readonly (...)[];
                  commits?: {
                      href?: ...;
                      name?: ...;
                  };
                  downloads?: {
                      href?: ...;
                      name?: ...;
                  };
                  forks?: {
                      href?: ...;
                      name?: ...;
                  };
                  hooks?: {
                      href?: ...;
                      name?: ...;
                  };
                  html?: {
                      href?: ...;
                      name?: ...;
                  };
                  pullrequests?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
                  watchers?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              mainbranch?: Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              } & {
                  default_merge_strategy?: (...) | (...);
                  merge_strategies?: (...) | (...);
              };
              name?: string;
              owner?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              project?: {
                  type: "project";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  has_publicly_visible_repos?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              };
              scm?: "git";
              size?: number;
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "repository";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          clone?: readonly (...)[];
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          downloads?: {
                              href?: ...;
                              name?: ...;
                          };
                          forks?: {
                              href?: ...;
                              name?: ...;
                          };
                          hooks?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          pullrequests?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          watchers?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      mainbranch?: Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      };
                      name?: string;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "repository";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        clone?: readonly (...)[];
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        downloads?: {
                            href?: ...;
                            name?: ...;
                        };
                        forks?: {
                            href?: ...;
                            name?: ...;
                        };
                        hooks?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        pullrequests?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        watchers?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    mainbranch?: Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    };
                    name?: string;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created fork.

        • content: {
              application/json: {
                  type: "repository";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      clone?: readonly (...)[];
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      downloads?: {
                          href?: ...;
                          name?: ...;
                      };
                      forks?: {
                          href?: ...;
                          name?: ...;
                      };
                      hooks?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      pullrequests?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      watchers?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  mainbranch?: Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  };
                  name?: string;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "repository";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                full_name?: string;
                has_issues?: boolean;
                has_wiki?: boolean;
                is_private?: boolean;
                language?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    clone?: readonly (...)[];
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    downloads?: {
                        href?: ...;
                        name?: ...;
                    };
                    forks?: {
                        href?: ...;
                        name?: ...;
                    };
                    hooks?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    pullrequests?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    watchers?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                mainbranch?: Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                };
                name?: string;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                parent?: { readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                size?: number;
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created fork

  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/hooks: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "webhook_subscription";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            active?: (...) | (...) | (...);
                            created_at?: (...) | (...);
                            description?: (...) | (...);
                            events?: (...) | (...);
                            secret?: (...) | (...);
                            secret_set?: (...) | (...) | (...);
                            subject?: (...) | (...);
                            subject_type?: (...) | (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "webhook_subscription";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            active?: (...) | (...) | (...);
                            created_at?: (...) | (...);
                            description?: (...) | (...);
                            events?: (...) | (...);
                            secret?: (...) | (...);
                            secret_set?: (...) | (...) | (...);
                            subject?: (...) | (...);
                            subject_type?: (...) | (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List webhooks for a repository

    Returns a paginated list of webhooks installed on this repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "webhook_subscription";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          active?: (...) | (...) | (...);
                          created_at?: (...) | (...);
                          description?: (...) | (...);
                          events?: (...) | (...);
                          secret?: (...) | (...);
                          secret_set?: (...) | (...) | (...);
                          subject?: (...) | (...);
                          subject_type?: (...) | (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "webhook_subscription";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        active?: (...) | (...) | (...);
                        created_at?: (...) | (...);
                        description?: (...) | (...);
                        events?: (...) | (...);
                        secret?: (...) | (...);
                        secret_set?: (...) | (...) | (...);
                        subject?: (...) | (...);
                        subject_type?: (...) | (...) | (...);
                        url?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of installed webhooks.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "webhook_subscription";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      active?: (...) | (...) | (...);
                      created_at?: (...) | (...);
                      description?: (...) | (...);
                      events?: (...) | (...);
                      secret?: (...) | (...);
                      secret_set?: (...) | (...) | (...);
                      subject?: (...) | (...);
                      subject_type?: (...) | (...) | (...);
                      url?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "webhook_subscription";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    active?: (...) | (...) | (...);
                    created_at?: (...) | (...);
                    description?: (...) | (...);
                    events?: (...) | (...);
                    secret?: (...) | (...);
                    secret_set?: (...) | (...) | (...);
                    subject?: (...) | (...);
                    subject_type?: (...) | (...) | (...);
                    url?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "webhook_subscription";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  active?: (...) | (...) | (...);
                  created_at?: (...) | (...);
                  description?: (...) | (...);
                  events?: (...) | (...);
                  secret?: (...) | (...);
                  secret_set?: (...) | (...) | (...);
                  subject?: (...) | (...);
                  subject_type?: (...) | (...) | (...);
                  url?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to access the webhooks.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a webhook for a repository

    Creates a new webhook on the specified repository.

    Example:
    
    ```
    $ curl -X POST -u credentials -H 'Content-Type: application/json'
      https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo-slug/hooks
      -d '
        {
          "description": "Webhook Description",
          "url": "https://example.com/",
          "active": true,
          "secret": "this is a really bad secret",
          "events": [
            "repo:push",
            "issue:created",
            "issue:updated"
          ]
        }'
    ```
    
    When the `secret` is provided it will be used as the key to generate a HMAC
    digest value sent in the `X-Hub-Signature` header at delivery time. Passing
    a `null` or empty `secret` or not passing a `secret` will leave the webhook's
    secret unset. Bitbucket only generates the `X-Hub-Signature` when the webhook's
    secret is set.
    
    Note that this call requires the webhook scope, as well as any scope
    that applies to the events that the webhook subscribes to. In the
    example above that means: `webhook`, `repository` and `issue`.
    
    Also note that the `url` must properly resolve and cannot be an
    internal, non-routed address.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        If the webhook was registered successfully.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of new newly created webhook.

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to install webhooks on the specified repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/hooks/{uid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            uid: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a webhook for a repository

    Deletes the specified webhook subscription from the given repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            uid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        When the webhook was deleted successfully

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to delete the webhook.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a webhook for a repository

    Returns the webhook with the specified id installed on the specified repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            uid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The webhook subscription object.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            uid: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          uid: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyuid: string

        Installed webhook's ID

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a webhook for a repository

    Updates the specified webhook subscription.

    The following properties can be mutated:
    
    * `description`
    * `url`
    * `secret`
    * `active`
    * `events`
    
    The hook's secret is used as a key to generate the HMAC hex digest sent in the
    `X-Hub-Signature` header at delivery time. This signature is only generated
    when the hook has a secret.
    
    Set the hook's secret by passing the new value in the `secret` field. Passing a
    `null` value in the `secret` field will remove the secret from the hook. The
    hook's secret can be left unchanged by not passing the `secret` field in the
    request.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            uid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The webhook subscription object.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to update the webhook.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    component?: {
                        type: "component";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        comments?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        vote?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        watch?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    votes?: number;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List issues

    Returns the issues in the issue tracker.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "issue";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          assignee?: (...) | (...);
                          component?: (...) | (...);
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          edited_on?: (...) | (...);
                          id?: (...) | (...);
                          kind?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          milestone?: (...) | (...);
                          priority?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          repository?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          version?: (...) | (...);
                          votes?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "issue";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        assignee?: (...) | (...);
                        component?: (...) | (...);
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        edited_on?: (...) | (...);
                        id?: (...) | (...);
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        milestone?: (...) | (...);
                        priority?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        repository?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        version?: (...) | (...);
                        votes?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of the issues matching any filter criteria that were provided.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "issue";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      assignee?: (...) | (...);
                      component?: (...) | (...);
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      edited_on?: (...) | (...);
                      id?: (...) | (...);
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      milestone?: (...) | (...);
                      priority?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      repository?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      version?: (...) | (...);
                      votes?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "issue";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    assignee?: (...) | (...);
                    component?: (...) | (...);
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    edited_on?: (...) | (...);
                    id?: (...) | (...);
                    kind?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    milestone?: (...) | (...);
                    priority?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    repository?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    version?: (...) | (...);
                    votes?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "issue";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  assignee?: (...) | (...);
                  component?: (...) | (...);
                  content?: (...) | (...);
                  created_on?: (...) | (...);
                  edited_on?: (...) | (...);
                  id?: (...) | (...);
                  kind?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  links?: (...) | (...);
                  milestone?: (...) | (...);
                  priority?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  reporter?: (...) | (...);
                  repository?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
                  version?: (...) | (...);
                  votes?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    component?: {
                        type: "component";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        comments?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        vote?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        watch?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: ...;
                        };
                        name?: string;
                    };
                    votes?: number;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create an issue

    Creates a new issue.

    This call requires authentication. Private repositories or private
    issue trackers require the caller to authenticate with an account that
    has appropriate authorization.
    
    The authenticated user is used for the issue's `reporter` field.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "issue";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  component?: {
                      type: "component";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: ...;
                      };
                      name?: string;
                  };
                  content?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      comments?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      vote?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      watch?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  milestone?: {
                      type: "milestone";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: ...;
                      };
                      name?: string;
                  };
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: ...;
                          clone?: ...;
                          commits?: ...;
                          downloads?: ...;
                          forks?: ...;
                          hooks?: ...;
                          html?: ...;
                          pullrequests?: ...;
                          self?: ...;
                          watchers?: ...;
                      };
                      mainbranch?: (...) & (...) & (...);
                      name?: string;
                      owner?: (...) & (...) & (...) & (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) & (...) & (...) & (...);
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: {
                      type: "version";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: ...;
                      };
                      name?: string;
                  };
                  votes?: number;
              };
          };
      }

      The new issue. The only required element is title. All other elements can be omitted from the body.

      • Readonlycontent: {
            application/json: {
                type: "issue";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                assignee?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                component?: {
                    type: "component";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: ...;
                    };
                    name?: string;
                };
                content?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on?: string;
                edited_on?: string;
                id?: number;
                kind?:
                    | "task"
                    | "bug"
                    | "enhancement"
                    | "proposal";
                links?: {
                    attachments?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    comments?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    vote?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    watch?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                milestone?: {
                    type: "milestone";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: ...;
                    };
                    name?: string;
                };
                priority?:
                    | "blocker"
                    | "critical"
                    | "major"
                    | "minor"
                    | "trivial";
                reporter?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                repository?: {
                    type: "repository";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: ...;
                        clone?: ...;
                        commits?: ...;
                        downloads?: ...;
                        forks?: ...;
                        hooks?: ...;
                        html?: ...;
                        pullrequests?: ...;
                        self?: ...;
                        watchers?: ...;
                    };
                    mainbranch?: (...) & (...) & (...);
                    name?: string;
                    owner?: (...) & (...) & (...) & (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) & (...) & (...) & (...);
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
                state?:
                    | "closed"
                    | "duplicate"
                    | "invalid"
                    | "new"
                    | "on hold"
                    | "open"
                    | "resolved"
                    | "submitted"
                    | "wontfix";
                title?: string;
                updated_on?: string;
                version?: {
                    type: "version";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: ...;
                    };
                    name?: string;
                };
                votes?: number;
            };
        }
        • Readonlyapplication/json: {
              type: "issue";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              assignee?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              component?: {
                  type: "component";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: ...;
                  };
                  name?: string;
              };
              content?: {
                  html?: string;
                  markup?: "creole" | "markdown" | "plaintext";
                  raw?: string;
              };
              created_on?: string;
              edited_on?: string;
              id?: number;
              kind?:
                  | "task"
                  | "bug"
                  | "enhancement"
                  | "proposal";
              links?: {
                  attachments?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  comments?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  vote?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  watch?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              milestone?: {
                  type: "milestone";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: ...;
                  };
                  name?: string;
              };
              priority?:
                  | "blocker"
                  | "critical"
                  | "major"
                  | "minor"
                  | "trivial";
              reporter?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              repository?: {
                  type: "repository";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: ...;
                      clone?: ...;
                      commits?: ...;
                      downloads?: ...;
                      forks?: ...;
                      hooks?: ...;
                      html?: ...;
                      pullrequests?: ...;
                      self?: ...;
                      watchers?: ...;
                  };
                  mainbranch?: (...) & (...) & (...);
                  name?: string;
                  owner?: (...) & (...) & (...) & (...);
                  parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                  project?: (...) & (...) & (...) & (...);
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
              state?:
                  | "closed"
                  | "duplicate"
                  | "invalid"
                  | "new"
                  | "on hold"
                  | "open"
                  | "resolved"
                  | "submitted"
                  | "wontfix";
              title?: string;
              updated_on?: string;
              version?: {
                  type: "version";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: ...;
                  };
                  name?: string;
              };
              votes?: number;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "issue";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      component?: {
                          type: "component";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      content?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          vote?: {
                              href?: ...;
                              name?: ...;
                          };
                          watch?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      milestone?: {
                          type: "milestone";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: {
                          type: "version";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      votes?: number;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    component?: {
                        type: "component";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        vote?: {
                            href?: ...;
                            name?: ...;
                        };
                        watch?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    votes?: number;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created issue.

        • content: {
              application/json: {
                  type: "issue";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  component?: {
                      type: "component";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  content?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      vote?: {
                          href?: ...;
                          name?: ...;
                      };
                      watch?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  milestone?: {
                      type: "milestone";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: {
                      type: "version";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  votes?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "issue";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                assignee?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                component?: {
                    type: "component";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                content?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on?: string;
                edited_on?: string;
                id?: number;
                kind?:
                    | "task"
                    | "bug"
                    | "enhancement"
                    | "proposal";
                links?: {
                    attachments?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    vote?: {
                        href?: ...;
                        name?: ...;
                    };
                    watch?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                milestone?: {
                    type: "milestone";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                priority?:
                    | "blocker"
                    | "critical"
                    | "major"
                    | "minor"
                    | "trivial";
                reporter?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?:
                    | "closed"
                    | "duplicate"
                    | "invalid"
                    | "new"
                    | "on hold"
                    | "open"
                    | "resolved"
                    | "submitted"
                    | "wontfix";
                title?: string;
                updated_on?: string;
                version?: {
                    type: "version";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                votes?: number;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The (absolute) URL of the newly created issue.

      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user isn't authorized to create the issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an issue

    Deletes the specified issue. This requires write access to the repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "issue";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      component?: {
                          type: "component";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      content?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          vote?: {
                              href?: ...;
                              name?: ...;
                          };
                          watch?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      milestone?: {
                          type: "milestone";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: {
                          type: "version";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      votes?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    component?: {
                        type: "component";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        vote?: {
                            href?: ...;
                            name?: ...;
                        };
                        watch?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    votes?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The issue object.

        • content: {
              application/json: {
                  type: "issue";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  component?: {
                      type: "component";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  content?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      vote?: {
                          href?: ...;
                          name?: ...;
                      };
                      watch?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  milestone?: {
                      type: "milestone";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: {
                      type: "version";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  votes?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "issue";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                assignee?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                component?: {
                    type: "component";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                content?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on?: string;
                edited_on?: string;
                id?: number;
                kind?:
                    | "task"
                    | "bug"
                    | "enhancement"
                    | "proposal";
                links?: {
                    attachments?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    vote?: {
                        href?: ...;
                        name?: ...;
                    };
                    watch?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                milestone?: {
                    type: "milestone";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                priority?:
                    | "blocker"
                    | "critical"
                    | "major"
                    | "minor"
                    | "trivial";
                reporter?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?:
                    | "closed"
                    | "duplicate"
                    | "invalid"
                    | "new"
                    | "on hold"
                    | "open"
                    | "resolved"
                    | "submitted"
                    | "wontfix";
                title?: string;
                updated_on?: string;
                version?: {
                    type: "version";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                votes?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user isn't authorized to delete the issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an issue

    Returns the specified issue.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "issue";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      component?: {
                          type: "component";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      content?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          vote?: {
                              href?: ...;
                              name?: ...;
                          };
                          watch?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      milestone?: {
                          type: "milestone";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: {
                          type: "version";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      votes?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          410: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    component?: {
                        type: "component";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        vote?: {
                            href?: ...;
                            name?: ...;
                        };
                        watch?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    votes?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The issue object.

        • content: {
              application/json: {
                  type: "issue";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  component?: {
                      type: "component";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  content?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      vote?: {
                          href?: ...;
                          name?: ...;
                      };
                      watch?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  milestone?: {
                      type: "milestone";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: {
                      type: "version";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  votes?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "issue";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                assignee?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                component?: {
                    type: "component";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                content?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on?: string;
                edited_on?: string;
                id?: number;
                kind?:
                    | "task"
                    | "bug"
                    | "enhancement"
                    | "proposal";
                links?: {
                    attachments?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    vote?: {
                        href?: ...;
                        name?: ...;
                    };
                    watch?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                milestone?: {
                    type: "milestone";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                priority?:
                    | "blocker"
                    | "critical"
                    | "major"
                    | "minor"
                    | "trivial";
                reporter?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?:
                    | "closed"
                    | "duplicate"
                    | "invalid"
                    | "new"
                    | "on hold"
                    | "open"
                    | "resolved"
                    | "submitted"
                    | "wontfix";
                title?: string;
                updated_on?: string;
                version?: {
                    type: "version";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                votes?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user isn't authorized to access the issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly410: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified issue is unavailable.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        component?: {
                            type: "component";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        content?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            vote?: {
                                href?: ...;
                                name?: ...;
                            };
                            watch?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        milestone?: {
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: {
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        votes?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an issue

    Modifies the issue.

    ```
    $ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \
      -u evzijst -s -X PUT -H 'Content-Type: application/json' \
      -d '{
      "title": "Updated title",
      "assignee": {
        "account_id": "5d5355e8c6b9320d9ea5b28d"
      },
      "priority": "minor",
      "version": {
        "name": "1.0"
      },
      "component": null
    }'
    ```
    
    This example changes the `title`, `assignee`, `priority` and the
    `version`. It also removes the value of the `component` from the issue
    by setting the field to `null`. Any field not present keeps its existing
    value.
    
    Each time an issue is edited in the UI or through the API, an immutable
    change record is created under the `/issues/123/changes` endpoint. It
    also has a comment associated with the change.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "issue";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      component?: {
                          type: "component";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      content?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          vote?: {
                              href?: ...;
                              name?: ...;
                          };
                          watch?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      milestone?: {
                          type: "milestone";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: {
                          type: "version";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      };
                      votes?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "issue";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    component?: {
                        type: "component";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    content?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        vote?: {
                            href?: ...;
                            name?: ...;
                        };
                        watch?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    milestone?: {
                        type: "milestone";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: {
                        type: "version";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    };
                    votes?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated issue object.

        • content: {
              application/json: {
                  type: "issue";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  component?: {
                      type: "component";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  content?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      vote?: {
                          href?: ...;
                          name?: ...;
                      };
                      watch?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  milestone?: {
                      type: "milestone";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: {
                      type: "version";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  };
                  votes?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "issue";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                assignee?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                component?: {
                    type: "component";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                content?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on?: string;
                edited_on?: string;
                id?: number;
                kind?:
                    | "task"
                    | "bug"
                    | "enhancement"
                    | "proposal";
                links?: {
                    attachments?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    vote?: {
                        href?: ...;
                        name?: ...;
                    };
                    watch?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                milestone?: {
                    type: "milestone";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                priority?:
                    | "blocker"
                    | "critical"
                    | "major"
                    | "minor"
                    | "trivial";
                reporter?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?:
                    | "closed"
                    | "duplicate"
                    | "invalid"
                    | "new"
                    | "on hold"
                    | "open"
                    | "resolved"
                    | "submitted"
                    | "wontfix";
                title?: string;
                updated_on?: string;
                version?: {
                    type: "version";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                };
                votes?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user isn't authorized to access the issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue_attachment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue_attachment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List attachments for an issue

    Returns all attachments for this issue.

    This returns the files' meta data. This does not return the files'
    actual contents.
    
    The files are always ordered by their upload date.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "issue_attachment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "issue_attachment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of all attachments for this issue.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "issue_attachment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "issue_attachment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "issue_attachment";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the issue tracker is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Upload an attachment to an issue

    Upload new issue attachments.

    To upload files, perform a `multipart/form-data` POST containing one
    or more file fields.
    
    When a file is uploaded with the same name as an existing attachment,
    then the existing file will be replaced.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        An empty response document.

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL to the issue's collection of attachments.

      • Readonly400: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If no files were uploaded, or if the wrong Content-Type was used.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the issue tracker is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an attachment for an issue

    Deletes an attachment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              path: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            path: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlypath: string

          Path to the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates that the deletion was successful

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the issue tracker is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get attachment for an issue

    Returns the contents of the specified file attachment.

    Note that this endpoint does not return a JSON response, but instead
    returns a redirect pointing to the actual file that in turn will return
    the raw contents.
    
    The redirect URL contains a one-time token that has a limited lifetime.
    As a result, the link should not be persisted, stored, or shared.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              path: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            path: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlypath: string

          Path to the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        A redirect to the file's contents

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the issue tracker is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          path: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlypath: string

        Path to the file.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            changes?: (...) | (...);
                            created_on?: (...) | (...);
                            issue?: (...) | (...);
                            links?: (...) | (...);
                            message?: (...) | (...);
                            name?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    changes?: {
                        assignee?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        component?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        content?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        kind?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        milestone?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        priority?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        state?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        title?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        version?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                    };
                    created_on?: string;
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                    links?: {
                        issue?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    message?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    name?: string;
                    type: string;
                    user?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        changes?: {
                            assignee?: {
                                new?: ...;
                                old?: ...;
                            };
                            component?: {
                                new?: ...;
                                old?: ...;
                            };
                            content?: {
                                new?: ...;
                                old?: ...;
                            };
                            kind?: {
                                new?: ...;
                                old?: ...;
                            };
                            milestone?: {
                                new?: ...;
                                old?: ...;
                            };
                            priority?: {
                                new?: ...;
                                old?: ...;
                            };
                            state?: {
                                new?: ...;
                                old?: ...;
                            };
                            title?: {
                                new?: ...;
                                old?: ...;
                            };
                            version?: {
                                new?: ...;
                                old?: ...;
                            };
                        };
                        created_on?: string;
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                        links?: {
                            issue?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        message?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        name?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            changes?: (...) | (...);
                            created_on?: (...) | (...);
                            issue?: (...) | (...);
                            links?: (...) | (...);
                            message?: (...) | (...);
                            name?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List changes on an issue

    Returns the list of all changes that have been made to the specified issue. Changes are returned in chronological order with the oldest change first.

    Each time an issue is edited in the UI or through the API, an immutable
    change record is created under the `/issues/123/changes` endpoint. It
    also has a comment associated with the change.
    
    Note that this operation is changing significantly, due to privacy changes.
    See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-the-issue-changes-api)
    for details.
    
    Changes support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) that
    can be used to search for specific changes. For instance, to see
    when an issue transitioned to "resolved":
    
    ```
    $ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \
       -G --data-urlencode='q=changes.state.new = "resolved"'
    ```
    
    This resource is only available on repositories that have the issue
    tracker enabled.
    
    N.B.
    
    The `changes.assignee` and `changes.assignee_account_id` fields are not
    a `user` object. Instead, they contain the raw `username` and
    `account_id` of the user. This is to protect the integrity of the audit
    log even after a user account gets deleted.
    
    The `changes.assignee` field is deprecated will disappear in the
    future. Use `changes.assignee_account_id` instead.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response. See filtering and sorting for details.

        • Optional Readonlysort?: string

          Name of a response property to sort results. See filtering and sorting for details.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          changes?: (...) | (...);
                          created_on?: (...) | (...);
                          issue?: (...) | (...);
                          links?: (...) | (...);
                          message?: (...) | (...);
                          name?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        changes?: (...) | (...);
                        created_on?: (...) | (...);
                        issue?: (...) | (...);
                        links?: (...) | (...);
                        message?: (...) | (...);
                        name?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Returns all the issue changes that were made on the specified issue.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      changes?: (...) | (...);
                      created_on?: (...) | (...);
                      issue?: (...) | (...);
                      links?: (...) | (...);
                      message?: (...) | (...);
                      name?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    changes?: (...) | (...);
                    created_on?: (...) | (...);
                    issue?: (...) | (...);
                    links?: (...) | (...);
                    message?: (...) | (...);
                    name?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  changes?: (...) | (...);
                  created_on?: (...) | (...);
                  issue?: (...) | (...);
                  links?: (...) | (...);
                  message?: (...) | (...);
                  name?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    changes?: {
                        assignee?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        component?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        content?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        kind?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        milestone?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        priority?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        state?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        title?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                        version?: {
                            new?: (...) | (...);
                            old?: (...) | (...);
                        };
                    };
                    created_on?: string;
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                    links?: {
                        issue?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    message?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    name?: string;
                    type: string;
                    user?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        changes?: {
                            assignee?: {
                                new?: ...;
                                old?: ...;
                            };
                            component?: {
                                new?: ...;
                                old?: ...;
                            };
                            content?: {
                                new?: ...;
                                old?: ...;
                            };
                            kind?: {
                                new?: ...;
                                old?: ...;
                            };
                            milestone?: {
                                new?: ...;
                                old?: ...;
                            };
                            priority?: {
                                new?: ...;
                                old?: ...;
                            };
                            state?: {
                                new?: ...;
                                old?: ...;
                            };
                            title?: {
                                new?: ...;
                                old?: ...;
                            };
                            version?: {
                                new?: ...;
                                old?: ...;
                            };
                        };
                        created_on?: string;
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                        links?: {
                            issue?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        message?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        name?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Modify the state of an issue

    Makes a change to the specified issue.

    For example, to change an issue's state and assignee, create a new
    change object that modifies these fields:
    
    ```
    curl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \
      -s -u evzijst -X POST -H "Content-Type: application/json" \
      -d '{
        "changes": {
          "assignee_account_id": {
            "new": "557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443"
          },
          "state": {
            "new": 'resolved"
          }
        }
        "message": {
          "raw": "This is now resolved."
        }
      }'
    ```
    
    The above example also includes a custom comment to go alongside the
    change. This comment will also be visible on the issue page in the UI.
    
    The fields of the `changes` object are strings, not objects. This
    allows for immutable change log records, even after user accounts,
    milestones, or other objects recorded in a change entry, get renamed or
    deleted.
    
    The `assignee_account_id` field stores the account id. When POSTing a
    new change and changing the assignee, the client should therefore use
    the user's account_id in the `changes.assignee_account_id.new` field.
    
    This call requires authentication. Private repositories or private
    issue trackers require the caller to authenticate with an account that
    has appropriate authorization.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  changes?: {
                      assignee?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      component?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      content?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      kind?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      milestone?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      priority?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      state?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      title?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                      version?: {
                          new?: (...) | (...);
                          old?: (...) | (...);
                      };
                  };
                  created_on?: string;
                  issue?: {
                      type: "issue";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: (...) & (...) & (...) & (...);
                      component?: (...) & (...) & (...) & (...);
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: ...;
                          comments?: ...;
                          html?: ...;
                          self?: ...;
                          vote?: ...;
                          watch?: ...;
                      };
                      milestone?: (...) & (...) & (...) & (...);
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: (...) & (...) & (...) & (...);
                      repository?: (...) & (...) & (...) & (...);
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: (...) & (...) & (...) & (...);
                      votes?: number;
                  };
                  links?: {
                      issue?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  message?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  name?: string;
                  type: string;
                  user?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
              };
          };
      }

      The new issue state change. The only required elements are changes.[].new. All other elements can be omitted from the body.

      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                changes?: {
                    assignee?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    component?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    content?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    kind?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    milestone?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    priority?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    state?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    title?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                    version?: {
                        new?: (...) | (...);
                        old?: (...) | (...);
                    };
                };
                created_on?: string;
                issue?: {
                    type: "issue";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: (...) & (...) & (...) & (...);
                    component?: (...) & (...) & (...) & (...);
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: ...;
                        comments?: ...;
                        html?: ...;
                        self?: ...;
                        vote?: ...;
                        watch?: ...;
                    };
                    milestone?: (...) & (...) & (...) & (...);
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: (...) & (...) & (...) & (...);
                    repository?: (...) & (...) & (...) & (...);
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: (...) & (...) & (...) & (...);
                    votes?: number;
                };
                links?: {
                    issue?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                message?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                name?: string;
                type: string;
                user?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              changes?: {
                  assignee?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  component?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  content?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  kind?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  milestone?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  priority?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  state?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  title?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
                  version?: {
                      new?: (...) | (...);
                      old?: (...) | (...);
                  };
              };
              created_on?: string;
              issue?: {
                  type: "issue";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: (...) & (...) & (...) & (...);
                  component?: (...) & (...) & (...) & (...);
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: ...;
                      comments?: ...;
                      html?: ...;
                      self?: ...;
                      vote?: ...;
                      watch?: ...;
                  };
                  milestone?: (...) & (...) & (...) & (...);
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: (...) & (...) & (...) & (...);
                  repository?: (...) & (...) & (...) & (...);
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: (...) & (...) & (...) & (...);
                  votes?: number;
              };
              links?: {
                  issue?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              message?: {
                  html?: string;
                  markup?: "creole" | "markdown" | "plaintext";
                  raw?: string;
              };
              name?: string;
              type: string;
              user?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      changes?: {
                          assignee?: {
                              new?: ...;
                              old?: ...;
                          };
                          component?: {
                              new?: ...;
                              old?: ...;
                          };
                          content?: {
                              new?: ...;
                              old?: ...;
                          };
                          kind?: {
                              new?: ...;
                              old?: ...;
                          };
                          milestone?: {
                              new?: ...;
                              old?: ...;
                          };
                          priority?: {
                              new?: ...;
                              old?: ...;
                          };
                          state?: {
                              new?: ...;
                              old?: ...;
                          };
                          title?: {
                              new?: ...;
                              old?: ...;
                          };
                          version?: {
                              new?: ...;
                              old?: ...;
                          };
                      };
                      created_on?: string;
                      issue?: {
                          type: "issue";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          assignee?: (...) | (...);
                          component?: (...) | (...);
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          edited_on?: (...) | (...);
                          id?: (...) | (...);
                          kind?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          milestone?: (...) | (...);
                          priority?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          repository?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          version?: (...) | (...);
                          votes?: (...) | (...);
                      };
                      links?: {
                          issue?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      message?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      name?: string;
                      type: string;
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    changes?: {
                        assignee?: {
                            new?: ...;
                            old?: ...;
                        };
                        component?: {
                            new?: ...;
                            old?: ...;
                        };
                        content?: {
                            new?: ...;
                            old?: ...;
                        };
                        kind?: {
                            new?: ...;
                            old?: ...;
                        };
                        milestone?: {
                            new?: ...;
                            old?: ...;
                        };
                        priority?: {
                            new?: ...;
                            old?: ...;
                        };
                        state?: {
                            new?: ...;
                            old?: ...;
                        };
                        title?: {
                            new?: ...;
                            old?: ...;
                        };
                        version?: {
                            new?: ...;
                            old?: ...;
                        };
                    };
                    created_on?: string;
                    issue?: {
                        type: "issue";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        assignee?: (...) | (...);
                        component?: (...) | (...);
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        edited_on?: (...) | (...);
                        id?: (...) | (...);
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        milestone?: (...) | (...);
                        priority?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        repository?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        version?: (...) | (...);
                        votes?: (...) | (...);
                    };
                    links?: {
                        issue?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    message?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    name?: string;
                    type: string;
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created issue change.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  changes?: {
                      assignee?: {
                          new?: ...;
                          old?: ...;
                      };
                      component?: {
                          new?: ...;
                          old?: ...;
                      };
                      content?: {
                          new?: ...;
                          old?: ...;
                      };
                      kind?: {
                          new?: ...;
                          old?: ...;
                      };
                      milestone?: {
                          new?: ...;
                          old?: ...;
                      };
                      priority?: {
                          new?: ...;
                          old?: ...;
                      };
                      state?: {
                          new?: ...;
                          old?: ...;
                      };
                      title?: {
                          new?: ...;
                          old?: ...;
                      };
                      version?: {
                          new?: ...;
                          old?: ...;
                      };
                  };
                  created_on?: string;
                  issue?: {
                      type: "issue";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      assignee?: (...) | (...);
                      component?: (...) | (...);
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      edited_on?: (...) | (...);
                      id?: (...) | (...);
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      milestone?: (...) | (...);
                      priority?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      repository?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      version?: (...) | (...);
                      votes?: (...) | (...);
                  };
                  links?: {
                      issue?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  message?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  name?: string;
                  type: string;
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                changes?: {
                    assignee?: {
                        new?: ...;
                        old?: ...;
                    };
                    component?: {
                        new?: ...;
                        old?: ...;
                    };
                    content?: {
                        new?: ...;
                        old?: ...;
                    };
                    kind?: {
                        new?: ...;
                        old?: ...;
                    };
                    milestone?: {
                        new?: ...;
                        old?: ...;
                    };
                    priority?: {
                        new?: ...;
                        old?: ...;
                    };
                    state?: {
                        new?: ...;
                        old?: ...;
                    };
                    title?: {
                        new?: ...;
                        old?: ...;
                    };
                    version?: {
                        new?: ...;
                        old?: ...;
                    };
                };
                created_on?: string;
                issue?: {
                    type: "issue";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    assignee?: (...) | (...);
                    component?: (...) | (...);
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    edited_on?: (...) | (...);
                    id?: (...) | (...);
                    kind?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    milestone?: (...) | (...);
                    priority?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    repository?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    version?: (...) | (...);
                    votes?: (...) | (...);
                };
                links?: {
                    issue?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                message?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                name?: string;
                type: string;
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The (absolute) URL of the newly created issue change.

      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user isn't authorized to modify the issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                change_id: string;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        changes?: {
                            assignee?: {
                                new?: ...;
                                old?: ...;
                            };
                            component?: {
                                new?: ...;
                                old?: ...;
                            };
                            content?: {
                                new?: ...;
                                old?: ...;
                            };
                            kind?: {
                                new?: ...;
                                old?: ...;
                            };
                            milestone?: {
                                new?: ...;
                                old?: ...;
                            };
                            priority?: {
                                new?: ...;
                                old?: ...;
                            };
                            state?: {
                                new?: ...;
                                old?: ...;
                            };
                            title?: {
                                new?: ...;
                                old?: ...;
                            };
                            version?: {
                                new?: ...;
                                old?: ...;
                            };
                        };
                        created_on?: string;
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                        links?: {
                            issue?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        message?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        name?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            change_id: string;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                change_id: string;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        changes?: {
                            assignee?: {
                                new?: ...;
                                old?: ...;
                            };
                            component?: {
                                new?: ...;
                                old?: ...;
                            };
                            content?: {
                                new?: ...;
                                old?: ...;
                            };
                            kind?: {
                                new?: ...;
                                old?: ...;
                            };
                            milestone?: {
                                new?: ...;
                                old?: ...;
                            };
                            priority?: {
                                new?: ...;
                                old?: ...;
                            };
                            state?: {
                                new?: ...;
                                old?: ...;
                            };
                            title?: {
                                new?: ...;
                                old?: ...;
                            };
                            version?: {
                                new?: ...;
                                old?: ...;
                            };
                        };
                        created_on?: string;
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                        links?: {
                            issue?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        message?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        name?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get issue change object

    Returns the specified issue change object.

    This resource is only available on repositories that have the issue
    tracker enabled.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              change_id: string;
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            change_id: string;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlychange_id: string

          The issue change id

        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      changes?: {
                          assignee?: {
                              new?: ...;
                              old?: ...;
                          };
                          component?: {
                              new?: ...;
                              old?: ...;
                          };
                          content?: {
                              new?: ...;
                              old?: ...;
                          };
                          kind?: {
                              new?: ...;
                              old?: ...;
                          };
                          milestone?: {
                              new?: ...;
                              old?: ...;
                          };
                          priority?: {
                              new?: ...;
                              old?: ...;
                          };
                          state?: {
                              new?: ...;
                              old?: ...;
                          };
                          title?: {
                              new?: ...;
                              old?: ...;
                          };
                          version?: {
                              new?: ...;
                              old?: ...;
                          };
                      };
                      created_on?: string;
                      issue?: {
                          type: "issue";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          assignee?: (...) | (...);
                          component?: (...) | (...);
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          edited_on?: (...) | (...);
                          id?: (...) | (...);
                          kind?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          milestone?: (...) | (...);
                          priority?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          repository?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          version?: (...) | (...);
                          votes?: (...) | (...);
                      };
                      links?: {
                          issue?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      message?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      name?: string;
                      type: string;
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    changes?: {
                        assignee?: {
                            new?: ...;
                            old?: ...;
                        };
                        component?: {
                            new?: ...;
                            old?: ...;
                        };
                        content?: {
                            new?: ...;
                            old?: ...;
                        };
                        kind?: {
                            new?: ...;
                            old?: ...;
                        };
                        milestone?: {
                            new?: ...;
                            old?: ...;
                        };
                        priority?: {
                            new?: ...;
                            old?: ...;
                        };
                        state?: {
                            new?: ...;
                            old?: ...;
                        };
                        title?: {
                            new?: ...;
                            old?: ...;
                        };
                        version?: {
                            new?: ...;
                            old?: ...;
                        };
                    };
                    created_on?: string;
                    issue?: {
                        type: "issue";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        assignee?: (...) | (...);
                        component?: (...) | (...);
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        edited_on?: (...) | (...);
                        id?: (...) | (...);
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        milestone?: (...) | (...);
                        priority?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        repository?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        version?: (...) | (...);
                        votes?: (...) | (...);
                    };
                    links?: {
                        issue?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    message?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    name?: string;
                    type: string;
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified issue change object.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  changes?: {
                      assignee?: {
                          new?: ...;
                          old?: ...;
                      };
                      component?: {
                          new?: ...;
                          old?: ...;
                      };
                      content?: {
                          new?: ...;
                          old?: ...;
                      };
                      kind?: {
                          new?: ...;
                          old?: ...;
                      };
                      milestone?: {
                          new?: ...;
                          old?: ...;
                      };
                      priority?: {
                          new?: ...;
                          old?: ...;
                      };
                      state?: {
                          new?: ...;
                          old?: ...;
                      };
                      title?: {
                          new?: ...;
                          old?: ...;
                      };
                      version?: {
                          new?: ...;
                          old?: ...;
                      };
                  };
                  created_on?: string;
                  issue?: {
                      type: "issue";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      assignee?: (...) | (...);
                      component?: (...) | (...);
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      edited_on?: (...) | (...);
                      id?: (...) | (...);
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      milestone?: (...) | (...);
                      priority?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      repository?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      version?: (...) | (...);
                      votes?: (...) | (...);
                  };
                  links?: {
                      issue?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  message?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  name?: string;
                  type: string;
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                changes?: {
                    assignee?: {
                        new?: ...;
                        old?: ...;
                    };
                    component?: {
                        new?: ...;
                        old?: ...;
                    };
                    content?: {
                        new?: ...;
                        old?: ...;
                    };
                    kind?: {
                        new?: ...;
                        old?: ...;
                    };
                    milestone?: {
                        new?: ...;
                        old?: ...;
                    };
                    priority?: {
                        new?: ...;
                        old?: ...;
                    };
                    state?: {
                        new?: ...;
                        old?: ...;
                    };
                    title?: {
                        new?: ...;
                        old?: ...;
                    };
                    version?: {
                        new?: ...;
                        old?: ...;
                    };
                };
                created_on?: string;
                issue?: {
                    type: "issue";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    assignee?: (...) | (...);
                    component?: (...) | (...);
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    edited_on?: (...) | (...);
                    id?: (...) | (...);
                    kind?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    milestone?: (...) | (...);
                    priority?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    repository?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    version?: (...) | (...);
                    votes?: (...) | (...);
                };
                links?: {
                    issue?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                message?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                name?: string;
                type: string;
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue change does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            change_id: string;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          change_id: string;
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlychange_id: string

        The issue change id

      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            issue?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "issue_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            issue?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List comments on an issue

    Returns a paginated list of all comments that were made on the specified issue.

    The default sorting is oldest to newest and can be overridden with
    the `sort` query parameter.
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "issue_comment";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          issue?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "issue_comment";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        issue?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of issue comments.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "issue_comment";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      issue?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "issue_comment";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    issue?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "issue_comment";
              } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  issue?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                };
            };
        };
        responses: {
            201: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a comment on an issue

    Creates a new issue comment.

    ```
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \
      -X POST -u evzijst \
      -H 'Content-Type: application/json' \
      -d '{"content": {"raw": "Lorem ipsum."}}'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "issue_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  issue?: {
                      type: "issue";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: (...) & (...) & (...) & (...);
                      component?: (...) & (...) & (...) & (...);
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: ...;
                          comments?: ...;
                          html?: ...;
                          self?: ...;
                          vote?: ...;
                          watch?: ...;
                      };
                      milestone?: (...) & (...) & (...) & (...);
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: (...) & (...) & (...) & (...);
                      repository?: (...) & (...) & (...) & (...);
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: (...) & (...) & (...) & (...);
                      votes?: number;
                  };
              };
          };
      }

      The new issue comment object.

      • Readonlycontent: {
            application/json: {
                type: "issue_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                issue?: {
                    type: "issue";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: (...) & (...) & (...) & (...);
                    component?: (...) & (...) & (...) & (...);
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: ...;
                        comments?: ...;
                        html?: ...;
                        self?: ...;
                        vote?: ...;
                        watch?: ...;
                    };
                    milestone?: (...) & (...) & (...) & (...);
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: (...) & (...) & (...) & (...);
                    repository?: (...) & (...) & (...) & (...);
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: (...) & (...) & (...) & (...);
                    votes?: number;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "issue_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              issue?: {
                  type: "issue";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: (...) & (...) & (...) & (...);
                  component?: (...) & (...) & (...) & (...);
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: ...;
                      comments?: ...;
                      html?: ...;
                      self?: ...;
                      vote?: ...;
                      watch?: ...;
                  };
                  milestone?: (...) & (...) & (...) & (...);
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: (...) & (...) & (...) & (...);
                  repository?: (...) & (...) & (...) & (...);
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: (...) & (...) & (...) & (...);
                  votes?: number;
              };
          }
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created comment.

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly issue comment.

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input was invalid, or if the comment being created is detected as spam

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a comment on an issue

    Deletes the specified comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates successful deletion.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a comment on an issue

    Returns the specified issue comment object.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "issue_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      issue?: {
                          type: "issue";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          assignee?: (...) | (...);
                          component?: (...) | (...);
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          edited_on?: (...) | (...);
                          id?: (...) | (...);
                          kind?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          milestone?: (...) | (...);
                          priority?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          repository?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          version?: (...) | (...);
                          votes?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        assignee?: (...) | (...);
                        component?: (...) | (...);
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        edited_on?: (...) | (...);
                        id?: (...) | (...);
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        milestone?: (...) | (...);
                        priority?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        repository?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        version?: (...) | (...);
                        votes?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The issue comment.

        • content: {
              application/json: {
                  type: "issue_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  issue?: {
                      type: "issue";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      assignee?: (...) | (...);
                      component?: (...) | (...);
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      edited_on?: (...) | (...);
                      id?: (...) | (...);
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      milestone?: (...) | (...);
                      priority?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      repository?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      version?: (...) | (...);
                      votes?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "issue_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                issue?: {
                    type: "issue";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    assignee?: (...) | (...);
                    component?: (...) | (...);
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    edited_on?: (...) | (...);
                    id?: (...) | (...);
                    kind?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    milestone?: (...) | (...);
                    priority?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    repository?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    version?: (...) | (...);
                    votes?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          comment_id: number;
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycomment_id: number

        The id of the comment.

      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        assignee?: (...) & (...) & (...) & (...);
                        component?: (...) & (...) & (...) & (...);
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        edited_on?: string;
                        id?: number;
                        kind?:
                            | "task"
                            | "bug"
                            | "enhancement"
                            | "proposal";
                        links?: {
                            attachments?: ...;
                            comments?: ...;
                            html?: ...;
                            self?: ...;
                            vote?: ...;
                            watch?: ...;
                        };
                        milestone?: (...) & (...) & (...) & (...);
                        priority?:
                            | "blocker"
                            | "critical"
                            | "major"
                            | "minor"
                            | "trivial";
                        reporter?: (...) & (...) & (...) & (...);
                        repository?: (...) & (...) & (...) & (...);
                        state?:
                            | "closed"
                            | "duplicate"
                            | "invalid"
                            | "new"
                            | "on hold"
                            | "open"
                            | "resolved"
                            | "submitted"
                            | "wontfix";
                        title?: string;
                        updated_on?: string;
                        version?: (...) & (...) & (...) & (...);
                        votes?: number;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "issue_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        issue?: {
                            type: "issue";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            assignee?: (...) | (...);
                            component?: (...) | (...);
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            edited_on?: (...) | (...);
                            id?: (...) | (...);
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            links?: (...) | (...);
                            milestone?: (...) | (...);
                            priority?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            reporter?: (...) | (...);
                            repository?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                            version?: (...) | (...);
                            votes?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a comment on an issue

    Updates the content of the specified issue comment. Note that only the content.raw field can be modified.

    ```
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \
      -X PUT -u evzijst \
      -H 'Content-Type: application/json' \
      -d '{"content": {"raw": "Lorem ipsum."}'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "issue_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  issue?: {
                      type: "issue";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      assignee?: (...) & (...) & (...) & (...);
                      component?: (...) & (...) & (...) & (...);
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      edited_on?: string;
                      id?: number;
                      kind?:
                          | "task"
                          | "bug"
                          | "enhancement"
                          | "proposal";
                      links?: {
                          attachments?: ...;
                          comments?: ...;
                          html?: ...;
                          self?: ...;
                          vote?: ...;
                          watch?: ...;
                      };
                      milestone?: (...) & (...) & (...) & (...);
                      priority?:
                          | "blocker"
                          | "critical"
                          | "major"
                          | "minor"
                          | "trivial";
                      reporter?: (...) & (...) & (...) & (...);
                      repository?: (...) & (...) & (...) & (...);
                      state?:
                          | "closed"
                          | "duplicate"
                          | "invalid"
                          | "new"
                          | "on hold"
                          | "open"
                          | "resolved"
                          | "submitted"
                          | "wontfix";
                      title?: string;
                      updated_on?: string;
                      version?: (...) & (...) & (...) & (...);
                      votes?: number;
                  };
              };
          };
      }

      The updated comment.

      • Readonlycontent: {
            application/json: {
                type: "issue_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                issue?: {
                    type: "issue";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    assignee?: (...) & (...) & (...) & (...);
                    component?: (...) & (...) & (...) & (...);
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    edited_on?: string;
                    id?: number;
                    kind?:
                        | "task"
                        | "bug"
                        | "enhancement"
                        | "proposal";
                    links?: {
                        attachments?: ...;
                        comments?: ...;
                        html?: ...;
                        self?: ...;
                        vote?: ...;
                        watch?: ...;
                    };
                    milestone?: (...) & (...) & (...) & (...);
                    priority?:
                        | "blocker"
                        | "critical"
                        | "major"
                        | "minor"
                        | "trivial";
                    reporter?: (...) & (...) & (...) & (...);
                    repository?: (...) & (...) & (...) & (...);
                    state?:
                        | "closed"
                        | "duplicate"
                        | "invalid"
                        | "new"
                        | "on hold"
                        | "open"
                        | "resolved"
                        | "submitted"
                        | "wontfix";
                    title?: string;
                    updated_on?: string;
                    version?: (...) & (...) & (...) & (...);
                    votes?: number;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "issue_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              issue?: {
                  type: "issue";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  assignee?: (...) & (...) & (...) & (...);
                  component?: (...) & (...) & (...) & (...);
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  edited_on?: string;
                  id?: number;
                  kind?:
                      | "task"
                      | "bug"
                      | "enhancement"
                      | "proposal";
                  links?: {
                      attachments?: ...;
                      comments?: ...;
                      html?: ...;
                      self?: ...;
                      vote?: ...;
                      watch?: ...;
                  };
                  milestone?: (...) & (...) & (...) & (...);
                  priority?:
                      | "blocker"
                      | "critical"
                      | "major"
                      | "minor"
                      | "trivial";
                  reporter?: (...) & (...) & (...) & (...);
                  repository?: (...) & (...) & (...) & (...);
                  state?:
                      | "closed"
                      | "duplicate"
                      | "invalid"
                      | "new"
                      | "on hold"
                      | "open"
                      | "resolved"
                      | "submitted"
                      | "wontfix";
                  title?: string;
                  updated_on?: string;
                  version?: (...) & (...) & (...) & (...);
                  votes?: number;
              };
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "issue_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      issue?: {
                          type: "issue";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          assignee?: (...) | (...);
                          component?: (...) | (...);
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          edited_on?: (...) | (...);
                          id?: (...) | (...);
                          kind?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          links?: (...) | (...);
                          milestone?: (...) | (...);
                          priority?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          reporter?: (...) | (...);
                          repository?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                          version?: (...) | (...);
                          votes?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "issue_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    issue?: {
                        type: "issue";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        assignee?: (...) | (...);
                        component?: (...) | (...);
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        edited_on?: (...) | (...);
                        id?: (...) | (...);
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        links?: (...) | (...);
                        milestone?: (...) | (...);
                        priority?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        reporter?: (...) | (...);
                        repository?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                        version?: (...) | (...);
                        votes?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated issue comment.

        • content: {
              application/json: {
                  type: "issue_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  issue?: {
                      type: "issue";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      assignee?: (...) | (...);
                      component?: (...) | (...);
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      edited_on?: (...) | (...);
                      id?: (...) | (...);
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      links?: (...) | (...);
                      milestone?: (...) | (...);
                      priority?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      reporter?: (...) | (...);
                      repository?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                      version?: (...) | (...);
                      votes?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "issue_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                issue?: {
                    type: "issue";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    assignee?: (...) | (...);
                    component?: (...) | (...);
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    edited_on?: (...) | (...);
                    id?: (...) | (...);
                    kind?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    links?: (...) | (...);
                    milestone?: (...) | (...);
                    priority?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    reporter?: (...) | (...);
                    repository?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                    version?: (...) | (...);
                    votes?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input was invalid, or if the update to the comment is detected as spam

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Remove vote for an issue

    Retract your vote.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          default: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonlydefault: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Unexpected error.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Check if current user voted for an issue

    Check whether the authenticated user has voted for this issue. A 204 status code indicates that the user has voted, while a 404 implies they haven't.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user has not voted for this issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user has not voted for this issue, or when the repo does not exist, or does not have an issue tracker.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Vote for an issue

    Vote for this issue.

    To cast your vote, do an empty PUT. The 204 status code indicates that
    the operation was successful.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Indicating the authenticated user has cast their vote successfully.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Stop watching an issue

    Stop watching this issue.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates that the authenticated user successfully stopped watching this issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or issue does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Check if current user is watching a issue

    Indicated whether or not the authenticated user is watching this issue.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is watching this issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          issue_id: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyissue_id: string

        The issue id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                issue_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Watch an issue

    Start watching this issue.

    To start watching this issue, do an empty PUT. The 204 status code
    indicates that the operation was successful.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              issue_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            issue_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyissue_id: string

          The issue id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates that the authenticated user successfully started watching this issue.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/export: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    include_attachments?: boolean;
                    project_key?: string;
                    project_name?: string;
                    send_email?: boolean;
                    type: string;
                };
            };
        };
        responses: {
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    include_attachments?: boolean;
                    project_key?: string;
                    project_name?: string;
                    send_email?: boolean;
                    type: string;
                };
            };
        };
        responses: {
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Export issues

    A POST request to this endpoint initiates a new background celery task that archives the repo's issues.

    When the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the
    'Location' response header. This url is the endpoint for where the user can obtain their zip files."
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  include_attachments?: boolean;
                  project_key?: string;
                  project_name?: string;
                  send_email?: boolean;
                  type: string;
              };
          };
      }

      The options to apply to the export. Available options include project_key and project_name which, if specified, are used as the project key and name in the exported Jira json format. Option send_email specifies whether an email should be sent upon export result. Option include_attachments specifies whether attachments are included in the export.

      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                include_attachments?: boolean;
                project_key?: string;
                project_name?: string;
                send_email?: boolean;
                type: string;
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              include_attachments?: boolean;
              project_key?: string;
              project_name?: string;
              send_email?: boolean;
              type: string;
          }
    • Readonlyresponses: {
          202: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly202: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The export job has been accepted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated properly

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user does not have admin permission on the repo

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repo does not exist or does not have an issue tracker

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_name: string;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_name: string;
            repo_slug: string;
            task_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_name: string;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Check issue export status

    This endpoint is used to poll for the progress of an issue export job and return the zip file after the job is complete. As long as the job is running, this will return a 202 response with in the response body a description of the current status.

    After the job has been scheduled, but before it starts executing, the endpoint
    returns a 202 response with status `ACCEPTED`.
    
    Once it starts running, it is a 202 response with status `STARTED` and progress filled.
    
    After it is finished, it becomes a 200 response with status `SUCCESS` or `FAILURE`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_name: string;
              repo_slug: string;
              task_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_name: string;
            repo_slug: string;
            task_id: string;
            workspace: string;
        }
        • Readonlyrepo_name: string

          The name of the repo

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytask_id: string

          The ID of the export task

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          202: {
              content: {
                  application/json: {
                      count?: number;
                      pct?: number;
                      phase?: string;
                      status?:
                          | "ACCEPTED"
                          | "FAILURE"
                          | "RUNNING"
                          | "STARTED";
                      total?: number;
                      type?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly202: {
            content: {
                application/json: {
                    count?: number;
                    pct?: number;
                    phase?: string;
                    status?:
                        | "ACCEPTED"
                        | "FAILURE"
                        | "RUNNING"
                        | "STARTED";
                    total?: number;
                    type?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Export job accepted

        • content: {
              application/json: {
                  count?: number;
                  pct?: number;
                  phase?: string;
                  status?:
                      | "ACCEPTED"
                      | "FAILURE"
                      | "RUNNING"
                      | "STARTED";
                  total?: number;
                  type?: string;
              };
          }
          • Readonlyapplication/json: {
                count?: number;
                pct?: number;
                phase?: string;
                status?:
                    | "ACCEPTED"
                    | "FAILURE"
                    | "RUNNING"
                    | "STARTED";
                total?: number;
                type?: string;
            }
            • Optional Readonlycount?: number

              The total number of issues already imported/exported

            • Optional Readonlypct?: number

              The percentage of issues already imported/exported

            • Optional Readonlyphase?: string

              The phase of the import/export job

            • Optional Readonlystatus?:
                  | "ACCEPTED"
                  | "FAILURE"
                  | "RUNNING"
                  | "STARTED"

              The status of the import/export job

            • Optional Readonlytotal?: number

              The total number of issues being imported/exported

            • Optional Readonlytype?: string
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated properly

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user does not have admin permission on the repo

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No export job has begun

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_name: string;
            repo_slug: string;
            task_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_name: string;
          repo_slug: string;
          task_id: string;
          workspace: string;
      }
      • Readonlyrepo_name: string

        The name of the repo

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlytask_id: string

        The ID of the export task

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/issues/import: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Check issue import status

    When using GET, this endpoint reports the status of the current import task.

    After the job has been scheduled, but before it starts executing, the endpoint
    returns a 202 response with status `ACCEPTED`.
    
    Once it starts running, it is a 202 response with status `STARTED` and progress filled.
    
    After it is finished, it becomes a 200 response with status `SUCCESS` or `FAILURE`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      count?: number;
                      pct?: number;
                      phase?: string;
                      status?:
                          | "ACCEPTED"
                          | "FAILURE"
                          | "RUNNING"
                          | "STARTED";
                      total?: number;
                      type?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          202: {
              content: {
                  application/json: {
                      count?: number;
                      pct?: number;
                      phase?: string;
                      status?:
                          | "ACCEPTED"
                          | "FAILURE"
                          | "RUNNING"
                          | "STARTED";
                      total?: number;
                      type?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    count?: number;
                    pct?: number;
                    phase?: string;
                    status?:
                        | "ACCEPTED"
                        | "FAILURE"
                        | "RUNNING"
                        | "STARTED";
                    total?: number;
                    type?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Import job complete with either FAILURE or SUCCESS status

        • content: {
              application/json: {
                  count?: number;
                  pct?: number;
                  phase?: string;
                  status?:
                      | "ACCEPTED"
                      | "FAILURE"
                      | "RUNNING"
                      | "STARTED";
                  total?: number;
                  type?: string;
              };
          }
          • Readonlyapplication/json: {
                count?: number;
                pct?: number;
                phase?: string;
                status?:
                    | "ACCEPTED"
                    | "FAILURE"
                    | "RUNNING"
                    | "STARTED";
                total?: number;
                type?: string;
            }
            • Optional Readonlycount?: number

              The total number of issues already imported/exported

            • Optional Readonlypct?: number

              The percentage of issues already imported/exported

            • Optional Readonlyphase?: string

              The phase of the import/export job

            • Optional Readonlystatus?:
                  | "ACCEPTED"
                  | "FAILURE"
                  | "RUNNING"
                  | "STARTED"

              The status of the import/export job

            • Optional Readonlytotal?: number

              The total number of issues being imported/exported

            • Optional Readonlytype?: string
        • headers: Readonly<Record<string, unknown>>
      • Readonly202: {
            content: {
                application/json: {
                    count?: number;
                    pct?: number;
                    phase?: string;
                    status?:
                        | "ACCEPTED"
                        | "FAILURE"
                        | "RUNNING"
                        | "STARTED";
                    total?: number;
                    type?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Import job started

        • content: {
              application/json: {
                  count?: number;
                  pct?: number;
                  phase?: string;
                  status?:
                      | "ACCEPTED"
                      | "FAILURE"
                      | "RUNNING"
                      | "STARTED";
                  total?: number;
                  type?: string;
              };
          }
          • Readonlyapplication/json: {
                count?: number;
                pct?: number;
                phase?: string;
                status?:
                    | "ACCEPTED"
                    | "FAILURE"
                    | "RUNNING"
                    | "STARTED";
                total?: number;
                type?: string;
            }
            • Optional Readonlycount?: number

              The total number of issues already imported/exported

            • Optional Readonlypct?: number

              The percentage of issues already imported/exported

            • Optional Readonlyphase?: string

              The phase of the import/export job

            • Optional Readonlystatus?:
                  | "ACCEPTED"
                  | "FAILURE"
                  | "RUNNING"
                  | "STARTED"

              The status of the import/export job

            • Optional Readonlytotal?: number

              The total number of issues being imported/exported

            • Optional Readonlytype?: string
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated properly

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user does not have admin permission on the repo

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No export job has begun

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            202: {
                content: {
                    application/json: {
                        count?: number;
                        pct?: number;
                        phase?: string;
                        status?:
                            | "ACCEPTED"
                            | "FAILURE"
                            | "RUNNING"
                            | "STARTED";
                        total?: number;
                        type?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Import issues

    A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All existing issues will be deleted and replaced by the contents of the imported zip file.

    Imports are done through a multipart/form-data POST. There is one valid and required form field, with the name
    "archive," which needs to be a file field:
    
    ```
    $ curl -u <username> -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories/<owner_username>/<repo_slug>/issues/import
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          202: {
              content: {
                  application/json: {
                      count?: number;
                      pct?: number;
                      phase?: string;
                      status?:
                          | "ACCEPTED"
                          | "FAILURE"
                          | "RUNNING"
                          | "STARTED";
                      total?: number;
                      type?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly202: {
            content: {
                application/json: {
                    count?: number;
                    pct?: number;
                    phase?: string;
                    status?:
                        | "ACCEPTED"
                        | "FAILURE"
                        | "RUNNING"
                        | "STARTED";
                    total?: number;
                    type?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Import job accepted

        • content: {
              application/json: {
                  count?: number;
                  pct?: number;
                  phase?: string;
                  status?:
                      | "ACCEPTED"
                      | "FAILURE"
                      | "RUNNING"
                      | "STARTED";
                  total?: number;
                  type?: string;
              };
          }
          • Readonlyapplication/json: {
                count?: number;
                pct?: number;
                phase?: string;
                status?:
                    | "ACCEPTED"
                    | "FAILURE"
                    | "RUNNING"
                    | "STARTED";
                total?: number;
                type?: string;
            }
            • Optional Readonlycount?: number

              The total number of issues already imported/exported

            • Optional Readonlypct?: number

              The percentage of issues already imported/exported

            • Optional Readonlyphase?: string

              The phase of the import/export job

            • Optional Readonlystatus?:
                  | "ACCEPTED"
                  | "FAILURE"
                  | "RUNNING"
                  | "STARTED"

              The status of the import/export job

            • Optional Readonlytotal?: number

              The total number of issues being imported/exported

            • Optional Readonlytype?: string
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated properly

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the authenticated user does not have admin permission on the repo

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No export job has begun

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Import already running

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/merge-base/{revspec}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revspec: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            revspec: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                revspec: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the common ancestor between two commits

    Returns the best common ancestor between two commits, specified in a revspec of 2 commits (e.g. 3a8b42..9ff173).

    If more than one best common ancestor exists, only one will be returned. It is
    unspecified which will be returned.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              revspec: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            revspec: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyrevspec: string

          A commit range using double dot notation (e.g. 3a8b42..9ff173).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "commit";
                  } & Omit<{
                      type: "base_commit";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: (...) & (...) & (...) & (...);
                      date?: string;
                      hash?: string;
                      message?: string;
                      parents?: readonly (...)[];
                      summary?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "commit";
                } & Omit<{
                    type: "base_commit";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: (...) & (...) & (...) & (...);
                    date?: string;
                    hash?: string;
                    message?: string;
                    parents?: readonly (...)[];
                    summary?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The merge base of the provided spec.

        • content: {
              application/json: {
                  type: "commit";
              } & Omit<{
                  type: "base_commit";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: (...) & (...) & (...) & (...);
                  date?: string;
                  hash?: string;
                  message?: string;
                  parents?: readonly (...)[];
                  summary?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "commit";
            } & Omit<{
                type: "base_commit";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: (...) & (...) & (...) & (...);
                date?: string;
                hash?: string;
                message?: string;
                parents?: readonly (...)[];
                summary?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to any of the repositories specified.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or ref in the spec does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            revspec: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          revspec: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyrevspec: string

        A commit range using double dot notation (e.g. 3a8b42..9ff173).

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/milestones: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "milestone";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List milestones

    Returns the milestones that have been defined in the issue tracker.

    This resource is only available on repositories that have the issue
    tracker enabled.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "milestone";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "milestone";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The milestones that have been defined in the issue tracker.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "milestone";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "milestone";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "milestone";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  id?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/milestones/{milestone_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                milestone_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "milestone";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            milestone_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                milestone_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "milestone";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a milestone

    Returns the specified issue tracker milestone object.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              milestone_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            milestone_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlymilestone_id: number

          The milestone's id

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "milestone";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "milestone";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified milestone object.

        • content: {
              application/json: {
                  type: "milestone";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "milestone";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                id?: number;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or milestone does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            milestone_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          milestone_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlymilestone_id: number

        The milestone's id

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/override-settings: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        override_settings?: Record<string, unknown>;
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        override_settings?: Record<string, unknown>;
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Retrieve the inheritance state for repository settings

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      override_settings?: Record<string, unknown>;
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    override_settings?: Record<string, unknown>;
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository setting inheritance state

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  override_settings?: Record<string, unknown>;
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                override_settings?: Record<string, unknown>;
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If no repository exists at this location

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Set the inheritance state for repository settings

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The repository setting inheritance state was set and no content returned

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If no repository exists at this location

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/patch/{spec}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                spec: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a patch for two commits

    Produces a raw patch for a single commit (diffed against its first parent), or a patch-series for a revspec of 2 commits (e.g. 3a8b42..9ff173 where the first commit represents the source and the second commit the destination).

    In case of the latter (diffing a revspec), a patch series is returned
    for the commits on the source branch (`3a8b42` and its ancestors in
    our example).
    
    While similar to diffs, patches:
    
    * Have a commit header (username, commit message, etc)
    * Do not support the `path=foo/bar.py` query parameter
    
    The raw patch is returned as-is, in whatever encoding the files in the
    repository use. It is not decoded into unicode. As such, the
    content-type is `text/plain`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              spec: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            spec: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyspec: string

          A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw patches

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the diff was too large and timed out.

        Since this endpoint does not employ any form of pagination, but
        instead returns the diff as a single document, it can run into
        trouble on very large diffs. If Bitbucket times out in cases
        like these, a 555 status code is returned.
        
        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            spec: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          spec: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyspec: string

        A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/permissions-config/groups: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            group?: (...) | (...);
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            group?: (...) | (...);
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List explicit group permissions for a repository

    Returns a paginated list of explicit group permissions for the given repository. This endpoint does not support BBQL features.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          group?: (...) | (...);
                          links?: (...) | (...);
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          repository?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        group?: (...) | (...);
                        links?: (...) | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        repository?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Paginated of explicit group permissions on the repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      group?: (...) | (...);
                      links?: (...) | (...);
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      repository?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    group?: (...) | (...);
                    links?: (...) | (...);
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    repository?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  group?: (...) | (...);
                  links?: (...) | (...);
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  repository?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or both of the workspace and repository doesn't exist for the given identifiers.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            group_slug: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission: "admin" | "read" | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an explicit group permission for a repository

    Deletes the repository group permission between the requested repository and group, if one exists.

    Only users with admin permission for the repository may access this resource.
    
    The only authentication method supported for this endpoint is via app passwords.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Group permission deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace does not exist, the repository does not exist, or the group does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an explicit group permission for a repository

    Returns the group permission for a given group slug and repository

    Only users with admin permission for the repository may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    * `none`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      group?: {
                          type: "group";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          full_slug?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          slug?: (...) | (...);
                          workspace?: (...) | (...);
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "read"
                          | "write"
                          | "none";
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    group?: {
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "read"
                        | "write"
                        | "none";
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Group permission for group slug and repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  group?: {
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "read"
                      | "write"
                      | "none";
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                group?: {
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "read"
                    | "write"
                    | "none";
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The given user, workspace, and/or repository could not be found

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            group_slug: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          group_slug: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlygroup_slug: string

        Slug of the requested group.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission: "admin" | "read" | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an explicit group permission for a repository

    Updates the group permission, or grants a new permission if one does not already exist.

    Only users with admin permission for the repository may access this resource.
    
    The only authentication method supported for this endpoint is via app passwords.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  permission: "admin" | "read" | "write";
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                permission: "admin" | "read" | "write";
            };
        }
        • Readonlyapplication/json: {
              permission: "admin" | "read" | "write";
          }
          • Readonlypermission: "admin" | "read" | "write"
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      group?: {
                          type: "group";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          full_slug?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          slug?: (...) | (...);
                          workspace?: (...) | (...);
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "read"
                          | "write"
                          | "none";
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          402: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    group?: {
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "read"
                        | "write"
                        | "none";
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Group permission updated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  group?: {
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "read"
                      | "write"
                      | "none";
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                group?: {
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "read"
                    | "write"
                    | "none";
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No permission value was provided or the value is invalid(not one of read, write, or admin)

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly402: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        You have reached your plan's user limit and must upgrade before giving access to additional users.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace does not exist, the repository does not exist, or the group does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/permissions-config/users: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List explicit user permissions for a repository

    Returns a paginated list of explicit user permissions for the given repository. This endpoint does not support BBQL features.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          repository?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        repository?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Paginated of explicit user permissions on the repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      repository?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    repository?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  repository?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No repository exists for the given repository slug and workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            selected_user_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission: "admin" | "read" | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an explicit user permission for a repository

    Deletes the repository user permission between the requested repository and user, if one exists.

    Only users with admin permission for the repository may access this resource.
    
    The only authentication method for this endpoint is via app passwords.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyselected_user_id: string

          This can either be the UUID of the account, surrounded by curly-braces, for example: {account UUID}, OR an Atlassian Account ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The repository user permission was deleted and no content returned.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, repository, and user doesn't exist for the given identifiers.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an explicit user permission for a repository

    Returns the explicit user permission for a given user and repository.

    Only users with admin permission for the repository may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    * `none`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyselected_user_id: string

          This can either be the UUID of the account, surrounded by curly-braces, for example: {account UUID}, OR an Atlassian Account ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "read"
                          | "write"
                          | "none";
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                      user?: {
                          type: "user";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          account_id?: (...) | (...);
                          account_status?: (...) | (...);
                          has_2fa_enabled?: (...) | (...) | (...);
                          is_staff?: (...) | (...) | (...);
                          links?: (...) | (...);
                          nickname?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "read"
                        | "write"
                        | "none";
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                    user?: {
                        type: "user";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        account_id?: (...) | (...);
                        account_status?: (...) | (...);
                        has_2fa_enabled?: (...) | (...) | (...);
                        is_staff?: (...) | (...) | (...);
                        links?: (...) | (...);
                        nickname?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Explicit user permission for user and repository

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "read"
                      | "write"
                      | "none";
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
                  user?: {
                      type: "user";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      account_id?: (...) | (...);
                      account_status?: (...) | (...);
                      has_2fa_enabled?: (...) | (...) | (...);
                      is_staff?: (...) | (...) | (...);
                      links?: (...) | (...);
                      nickname?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "read"
                    | "write"
                    | "none";
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
                user?: {
                    type: "user";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    account_id?: (...) | (...);
                    account_status?: (...) | (...);
                    has_2fa_enabled?: (...) | (...) | (...);
                    is_staff?: (...) | (...) | (...);
                    links?: (...) | (...);
                    nickname?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or both of the workspace and repository doesn't exist for the given identifiers.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            selected_user_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          selected_user_id: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyselected_user_id: string

        This can either be the UUID of the account, surrounded by curly-braces, for example: {account UUID}, OR an Atlassian Account ID.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission: "admin" | "read" | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "read"
                            | "write"
                            | "none";
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an explicit user permission for a repository

    Updates the explicit user permission for a given user and repository. The selected user must be a member of the workspace, and cannot be the workspace owner. Only users with admin permission for the repository may access this resource.

    The only authentication method for this endpoint is via app passwords.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyselected_user_id: string

          This can either be the UUID of the account, surrounded by curly-braces, for example: {account UUID}, OR an Atlassian Account ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  permission: "admin" | "read" | "write";
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                permission: "admin" | "read" | "write";
            };
        }
        • Readonlyapplication/json: {
              permission: "admin" | "read" | "write";
          }
          • Readonlypermission: "admin" | "read" | "write"
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "read"
                          | "write"
                          | "none";
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                      user?: {
                          type: "user";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          account_id?: (...) | (...);
                          account_status?: (...) | (...);
                          has_2fa_enabled?: (...) | (...) | (...);
                          is_staff?: (...) | (...) | (...);
                          links?: (...) | (...);
                          nickname?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          402: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "read"
                        | "write"
                        | "none";
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                    user?: {
                        type: "user";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        account_id?: (...) | (...);
                        account_status?: (...) | (...);
                        has_2fa_enabled?: (...) | (...) | (...);
                        is_staff?: (...) | (...) | (...);
                        links?: (...) | (...);
                        nickname?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Explicit user permission updated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "read"
                      | "write"
                      | "none";
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
                  user?: {
                      type: "user";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      account_id?: (...) | (...);
                      account_status?: (...) | (...);
                      has_2fa_enabled?: (...) | (...) | (...);
                      is_staff?: (...) | (...) | (...);
                      links?: (...) | (...);
                      nickname?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "read"
                    | "write"
                    | "none";
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
                user?: {
                    type: "user";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    account_id?: (...) | (...);
                    account_status?: (...) | (...);
                    has_2fa_enabled?: (...) | (...) | (...);
                    is_staff?: (...) | (...) | (...);
                    links?: (...) | (...);
                    nickname?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No permission value was provided or the value is invalid (not one of read, write, or admin), or the selected user is not a valid user to update.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly402: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        You have reached your plan's user limit and must upgrade before giving access to additional users.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, repository, and selected user doesn't exist for the given identifiers.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            build_number?: (...) | (...);
                            build_seconds_used?: (...) | (...);
                            completed_on?: (...) | (...);
                            configuration_sources?: (...) | (...);
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            links?: (...) | (...);
                            repository?: (...) | (...);
                            state?: (...) | (...);
                            target?: (...) | (...);
                            trigger?: (...) | (...);
                            uuid?: (...) | (...);
                            variables?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    build_number?: number;
                    build_seconds_used?: number;
                    completed_on?: string;
                    configuration_sources?: readonly {
                        source: string;
                        uri: string;
                    }[];
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    links?: {
                        type: "pipelines_pipeline_links";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        self?: (...) & (...) & (...) & (...);
                        steps?: (...) & (...) & (...) & (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                    state?: {
                        type: "pipeline_state";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    target?: {
                        type: "pipeline_target";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    trigger?: {
                        type: "pipeline_trigger";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    uuid?: string;
                    variables?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        build_number?: number;
                        build_seconds_used?: number;
                        completed_on?: string;
                        configuration_sources?: readonly {
                            source: string;
                            uri: string;
                        }[];
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        links?: {
                            type: "pipelines_pipeline_links";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            self?: (...) | (...);
                            steps?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "pipeline_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        target?: {
                            type: "pipeline_target";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        trigger?: {
                            type: "pipeline_trigger";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                        variables?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            key?: ...;
                            secured?: ...;
                            uuid?: ...;
                            value?: ...;
                        })[];
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            build_number?: (...) | (...);
                            build_seconds_used?: (...) | (...);
                            completed_on?: (...) | (...);
                            configuration_sources?: (...) | (...);
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            links?: (...) | (...);
                            repository?: (...) | (...);
                            state?: (...) | (...);
                            target?: (...) | (...);
                            trigger?: (...) | (...);
                            uuid?: (...) | (...);
                            variables?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List pipelines

    Find pipelines

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          build_number?: (...) | (...);
                          build_seconds_used?: (...) | (...);
                          completed_on?: (...) | (...);
                          configuration_sources?: (...) | (...);
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          links?: (...) | (...);
                          repository?: (...) | (...);
                          state?: (...) | (...);
                          target?: (...) | (...);
                          trigger?: (...) | (...);
                          uuid?: (...) | (...);
                          variables?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        build_number?: (...) | (...);
                        build_seconds_used?: (...) | (...);
                        completed_on?: (...) | (...);
                        configuration_sources?: (...) | (...);
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        links?: (...) | (...);
                        repository?: (...) | (...);
                        state?: (...) | (...);
                        target?: (...) | (...);
                        trigger?: (...) | (...);
                        uuid?: (...) | (...);
                        variables?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The matching pipelines.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      build_number?: (...) | (...);
                      build_seconds_used?: (...) | (...);
                      completed_on?: (...) | (...);
                      configuration_sources?: (...) | (...);
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      links?: (...) | (...);
                      repository?: (...) | (...);
                      state?: (...) | (...);
                      target?: (...) | (...);
                      trigger?: (...) | (...);
                      uuid?: (...) | (...);
                      variables?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    build_number?: (...) | (...);
                    build_seconds_used?: (...) | (...);
                    completed_on?: (...) | (...);
                    configuration_sources?: (...) | (...);
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    links?: (...) | (...);
                    repository?: (...) | (...);
                    state?: (...) | (...);
                    target?: (...) | (...);
                    trigger?: (...) | (...);
                    uuid?: (...) | (...);
                    variables?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  build_number?: (...) | (...);
                  build_seconds_used?: (...) | (...);
                  completed_on?: (...) | (...);
                  configuration_sources?: (...) | (...);
                  created_on?: (...) | (...);
                  creator?: (...) | (...);
                  links?: (...) | (...);
                  repository?: (...) | (...);
                  state?: (...) | (...);
                  target?: (...) | (...);
                  trigger?: (...) | (...);
                  uuid?: (...) | (...);
                  variables?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    build_number?: number;
                    build_seconds_used?: number;
                    completed_on?: string;
                    configuration_sources?: readonly {
                        source: string;
                        uri: string;
                    }[];
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    links?: {
                        type: "pipelines_pipeline_links";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        self?: (...) & (...) & (...) & (...);
                        steps?: (...) & (...) & (...) & (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                    state?: {
                        type: "pipeline_state";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    target?: {
                        type: "pipeline_target";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    trigger?: {
                        type: "pipeline_trigger";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>>;
                    uuid?: string;
                    variables?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        build_number?: number;
                        build_seconds_used?: number;
                        completed_on?: string;
                        configuration_sources?: readonly {
                            source: string;
                            uri: string;
                        }[];
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        links?: {
                            type: "pipelines_pipeline_links";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            self?: (...) | (...);
                            steps?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "pipeline_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        target?: {
                            type: "pipeline_target";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        trigger?: {
                            type: "pipeline_trigger";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                        variables?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            key?: ...;
                            secured?: ...;
                            uuid?: ...;
                            value?: ...;
                        })[];
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Run a pipeline

    Endpoint to create and initiate a pipeline. There are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated. # Trigger a Pipeline for a branch One way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline. The specified branch will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch.

    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
     https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \
      -d '
      {
        "target": {
          "ref_type": "branch",
          "type": "pipeline_ref_target",
          "ref_name": "master"
        }
      }'
    ```
    # Trigger a Pipeline for a commit on a branch or tag
    You can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark).
    The specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference.
    
    The following reference types are supported:
    
    * `branch`
    * `named_branch`
    * `bookmark`
     * `tag`
    
    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \
      -d '
      {
        "target": {
          "commit": {
            "type": "commit",
            "hash": "ce5b7431602f7cbba007062eeb55225c6e18e956"
          },
          "ref_type": "branch",
          "type": "pipeline_ref_target",
          "ref_name": "master"
        }
      }'
    ```
    # Trigger a specific pipeline definition for a commit
    You can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit.
    In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.
    
    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
     https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \
     -d '
      {
         "target": {
          "commit": {
             "hash":"a3c4e02c9a3755eccdc3764e6ea13facdf30f923",
             "type":"commit"
           },
            "selector": {
               "type":"custom",
                  "pattern":"Deploy to production"
              },
            "type":"pipeline_commit_target"
       }
      }'
    ```
    # Trigger a specific pipeline definition for a commit on a branch or tag
    You can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit in the context of a specified reference.
    In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.
    
    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
     https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \
     -d '
      {
         "target": {
          "commit": {
             "hash":"a3c4e02c9a3755eccdc3764e6ea13facdf30f923",
             "type":"commit"
           },
           "selector": {
              "type": "custom",
              "pattern": "Deploy to production"
           },
           "type": "pipeline_ref_target",
           "ref_name": "master",
           "ref_type": "branch"
         }
      }'
    ```
    
    
    # Trigger a custom pipeline with variables
    In addition to triggering a custom pipeline that is defined in your `bitbucket-pipelines.yml` file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured).
    
    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
     https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
     -d '
      {
        "target": {
          "type": "pipeline_ref_target",
          "ref_type": "branch",
          "ref_name": "master",
          "selector": {
            "type": "custom",
            "pattern": "Deploy to production"
          }
        },
        "variables": [
          {
            "key": "var1key",
            "value": "var1value",
            "secured": true
          },
          {
            "key": "var2key",
            "value": "var2value"
          }
        ]
      }'
    ```
    
    # Trigger a pull request pipeline
    
    You can also initiate a pipeline for a specific pull request.
    
    ### Example
    
    ```
    $ curl -X POST -is -u username:password \
      -H 'Content-Type: application/json' \
     https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
     -d '
      {
        "target": {
          "type": "pipeline_pullrequest_target",
          "source": "pull-request-branch",
          "destination": "master",
          "destination_commit": {
            "hash": "9f848b7"
          },
          "commit": {
            "hash": "1a372fc"
          },
          "pullrequest": {
            "id": "3"
          },
          "selector": {
            "type": "pull-requests",
            "pattern": "**"
          }
        }
      }'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  build_number?: number;
                  build_seconds_used?: number;
                  completed_on?: string;
                  configuration_sources?: readonly {
                      source: string;
                      uri: string;
                  }[];
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  links?: {
                      type: "pipelines_pipeline_links";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      self?: (...) & (...) & (...) & (...);
                      steps?: (...) & (...) & (...) & (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: ...;
                          clone?: ...;
                          commits?: ...;
                          downloads?: ...;
                          forks?: ...;
                          hooks?: ...;
                          html?: ...;
                          pullrequests?: ...;
                          self?: ...;
                          watchers?: ...;
                      };
                      mainbranch?: (...) & (...) & (...);
                      name?: string;
                      owner?: (...) & (...) & (...) & (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) & (...) & (...) & (...);
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
                  state?: {
                      type: "pipeline_state";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>>;
                  target?: {
                      type: "pipeline_target";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>>;
                  trigger?: {
                      type: "pipeline_trigger";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>>;
                  uuid?: string;
                  variables?: readonly ({
                      type: "pipeline_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          };
      }

      The pipeline to initiate.

      • Readonlycontent: {
            application/json: {
                type: "pipeline";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                build_number?: number;
                build_seconds_used?: number;
                completed_on?: string;
                configuration_sources?: readonly {
                    source: string;
                    uri: string;
                }[];
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                links?: {
                    type: "pipelines_pipeline_links";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    self?: (...) & (...) & (...) & (...);
                    steps?: (...) & (...) & (...) & (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: ...;
                        clone?: ...;
                        commits?: ...;
                        downloads?: ...;
                        forks?: ...;
                        hooks?: ...;
                        html?: ...;
                        pullrequests?: ...;
                        self?: ...;
                        watchers?: ...;
                    };
                    mainbranch?: (...) & (...) & (...);
                    name?: string;
                    owner?: (...) & (...) & (...) & (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) & (...) & (...) & (...);
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
                state?: {
                    type: "pipeline_state";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>>;
                target?: {
                    type: "pipeline_target";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>>;
                trigger?: {
                    type: "pipeline_trigger";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>>;
                uuid?: string;
                variables?: readonly ({
                    type: "pipeline_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              build_number?: number;
              build_seconds_used?: number;
              completed_on?: string;
              configuration_sources?: readonly {
                  source: string;
                  uri: string;
              }[];
              created_on?: string;
              creator?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              links?: {
                  type: "pipelines_pipeline_links";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  self?: (...) & (...) & (...) & (...);
                  steps?: (...) & (...) & (...) & (...);
              };
              repository?: {
                  type: "repository";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: ...;
                      clone?: ...;
                      commits?: ...;
                      downloads?: ...;
                      forks?: ...;
                      hooks?: ...;
                      html?: ...;
                      pullrequests?: ...;
                      self?: ...;
                      watchers?: ...;
                  };
                  mainbranch?: (...) & (...) & (...);
                  name?: string;
                  owner?: (...) & (...) & (...) & (...);
                  parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                  project?: (...) & (...) & (...) & (...);
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
              state?: {
                  type: "pipeline_state";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>>;
              target?: {
                  type: "pipeline_target";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>>;
              trigger?: {
                  type: "pipeline_trigger";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>>;
              uuid?: string;
              variables?: readonly ({
                  type: "pipeline_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[];
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      build_number?: number;
                      build_seconds_used?: number;
                      completed_on?: string;
                      configuration_sources?: readonly {
                          source: string;
                          uri: string;
                      }[];
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      links?: {
                          type: "pipelines_pipeline_links";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          self?: (...) | (...);
                          steps?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?: {
                          type: "pipeline_state";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      target?: {
                          type: "pipeline_target";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      trigger?: {
                          type: "pipeline_trigger";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      uuid?: string;
                      variables?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          key?: ...;
                          secured?: ...;
                          uuid?: ...;
                          value?: ...;
                      })[];
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    build_number?: number;
                    build_seconds_used?: number;
                    completed_on?: string;
                    configuration_sources?: readonly {
                        source: string;
                        uri: string;
                    }[];
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    links?: {
                        type: "pipelines_pipeline_links";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        self?: (...) | (...);
                        steps?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?: {
                        type: "pipeline_state";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    target?: {
                        type: "pipeline_target";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    trigger?: {
                        type: "pipeline_trigger";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    uuid?: string;
                    variables?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        key?: ...;
                        secured?: ...;
                        uuid?: ...;
                        value?: ...;
                    })[];
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The initiated pipeline.

        • content: {
              application/json: {
                  type: "pipeline";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  build_number?: number;
                  build_seconds_used?: number;
                  completed_on?: string;
                  configuration_sources?: readonly {
                      source: string;
                      uri: string;
                  }[];
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  links?: {
                      type: "pipelines_pipeline_links";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      self?: (...) | (...);
                      steps?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?: {
                      type: "pipeline_state";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  target?: {
                      type: "pipeline_target";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  trigger?: {
                      type: "pipeline_trigger";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  uuid?: string;
                  variables?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      key?: ...;
                      secured?: ...;
                      uuid?: ...;
                      value?: ...;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                build_number?: number;
                build_seconds_used?: number;
                completed_on?: string;
                configuration_sources?: readonly {
                    source: string;
                    uri: string;
                }[];
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                links?: {
                    type: "pipelines_pipeline_links";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    self?: (...) | (...);
                    steps?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?: {
                    type: "pipeline_state";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                target?: {
                    type: "pipeline_target";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                trigger?: {
                    type: "pipeline_trigger";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                uuid?: string;
                variables?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    key?: ...;
                    secured?: ...;
                    uuid?: ...;
                    value?: ...;
                })[];
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline.

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository is not enabled, the yml file does not exist in the repository for the given revision, or the request body contained invalid properties.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipelines_config";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipelines_config";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipelines_config";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipelines_config";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get configuration

    Retrieve the repository pipelines configuration.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipelines_config";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      enabled?: boolean;
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipelines_config";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository pipelines configuration.

        • content: {
              application/json: {
                  type: "pipelines_config";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  enabled?: boolean;
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "pipelines_config";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                enabled?: boolean;
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipelines_config";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                    repository?: {
                        type: "repository";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                        full_name?: string;
                        has_issues?: boolean;
                        has_wiki?: boolean;
                        is_private?: boolean;
                        language?: string;
                        links?: {
                            avatar?: ...;
                            clone?: ...;
                            commits?: ...;
                            downloads?: ...;
                            forks?: ...;
                            hooks?: ...;
                            html?: ...;
                            pullrequests?: ...;
                            self?: ...;
                            watchers?: ...;
                        };
                        mainbranch?: (...) & (...) & (...);
                        name?: string;
                        owner?: (...) & (...) & (...) & (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        size?: number;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipelines_config";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        enabled?: boolean;
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update configuration

    Update the pipelines configuration for a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipelines_config";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  enabled?: boolean;
                  repository?: {
                      type: "repository";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                      full_name?: string;
                      has_issues?: boolean;
                      has_wiki?: boolean;
                      is_private?: boolean;
                      language?: string;
                      links?: {
                          avatar?: ...;
                          clone?: ...;
                          commits?: ...;
                          downloads?: ...;
                          forks?: ...;
                          hooks?: ...;
                          html?: ...;
                          pullrequests?: ...;
                          self?: ...;
                          watchers?: ...;
                      };
                      mainbranch?: (...) & (...) & (...);
                      name?: string;
                      owner?: (...) & (...) & (...) & (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) & (...) & (...) & (...);
                      scm?: "git";
                      size?: number;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
          };
      }

      The updated repository pipelines configuration.

      • Readonlycontent: {
            application/json: {
                type: "pipelines_config";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                enabled?: boolean;
                repository?: {
                    type: "repository";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                    full_name?: string;
                    has_issues?: boolean;
                    has_wiki?: boolean;
                    is_private?: boolean;
                    language?: string;
                    links?: {
                        avatar?: ...;
                        clone?: ...;
                        commits?: ...;
                        downloads?: ...;
                        forks?: ...;
                        hooks?: ...;
                        html?: ...;
                        pullrequests?: ...;
                        self?: ...;
                        watchers?: ...;
                    };
                    mainbranch?: (...) & (...) & (...);
                    name?: string;
                    owner?: (...) & (...) & (...) & (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) & (...) & (...) & (...);
                    scm?: "git";
                    size?: number;
                    updated_on?: string;
                    uuid?: string;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "pipelines_config";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              enabled?: boolean;
              repository?: {
                  type: "repository";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  fork_policy?: "allow_forks" | "no_forks" | "no_public_forks";
                  full_name?: string;
                  has_issues?: boolean;
                  has_wiki?: boolean;
                  is_private?: boolean;
                  language?: string;
                  links?: {
                      avatar?: ...;
                      clone?: ...;
                      commits?: ...;
                      downloads?: ...;
                      forks?: ...;
                      hooks?: ...;
                      html?: ...;
                      pullrequests?: ...;
                      self?: ...;
                      watchers?: ...;
                  };
                  mainbranch?: (...) & (...) & (...);
                  name?: string;
                  owner?: (...) & (...) & (...) & (...);
                  parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                  project?: (...) & (...) & (...) & (...);
                  scm?: "git";
                  size?: number;
                  updated_on?: string;
                  uuid?: string;
              };
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipelines_config";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      enabled?: boolean;
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipelines_config";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository pipelines configuration was updated.

        • content: {
              application/json: {
                  type: "pipelines_config";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  enabled?: boolean;
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "pipelines_config";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                enabled?: boolean;
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/build_number: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_build_number";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    next?: number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_build_number";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        next?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_build_number";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    next?: number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_build_number";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        next?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update the next build number

    Update the next build number that should be assigned to a pipeline. The next build number that will be configured has to be strictly higher than the current latest build number for this repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_build_number";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  next?: number;
              };
          };
      }

      The build number to update.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_build_number";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                next?: number;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_build_number";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              next?: number;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_build_number";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      next?: number;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_build_number";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    next?: number;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The build number has been configured.

        • content: {
              application/json: {
                  type: "pipeline_build_number";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  next?: number;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_build_number";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                next?: number;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The update failed because the next number was invalid (it should be higher than the current number).

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_schedule";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            cron_pattern?: (...) | (...);
                            enabled?: (...) | (...) | (...);
                            target?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_schedule_post_request_body";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    cron_pattern: string;
                    enabled?: boolean;
                    target: {
                        ref_name: string;
                        ref_type: "branch";
                        selector: never;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_schedule";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            cron_pattern?: (...) | (...);
                            enabled?: (...) | (...) | (...);
                            target?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List schedules

    Retrieve the configured schedules for the given repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_schedule";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          cron_pattern?: (...) | (...);
                          enabled?: (...) | (...) | (...);
                          target?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_schedule";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        cron_pattern?: (...) | (...);
                        enabled?: (...) | (...) | (...);
                        target?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of schedules.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_schedule";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      cron_pattern?: (...) | (...);
                      enabled?: (...) | (...) | (...);
                      target?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_schedule";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    cron_pattern?: (...) | (...);
                    enabled?: (...) | (...) | (...);
                    target?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_schedule";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  cron_pattern?: (...) | (...);
                  enabled?: (...) | (...) | (...);
                  target?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_schedule_post_request_body";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    cron_pattern: string;
                    enabled?: boolean;
                    target: {
                        ref_name: string;
                        ref_type: "branch";
                        selector: never;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a schedule

    Create a schedule for the given repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_schedule_post_request_body";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  cron_pattern: string;
                  enabled?: boolean;
                  target: {
                      ref_name: string;
                      ref_type: "branch";
                      selector: never;
                  };
              };
          };
      }

      The schedule to create.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_schedule_post_request_body";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                cron_pattern: string;
                enabled?: boolean;
                target: {
                    ref_name: string;
                    ref_type: "branch";
                    selector: never;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_schedule_post_request_body";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              cron_pattern: string;
              enabled?: boolean;
              target: {
                  ref_name: string;
                  ref_type: "branch";
                  selector: never;
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_schedule";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      cron_pattern?: string;
                      enabled?: boolean;
                      target?: {
                          type: "pipeline_ref_target";
                      } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          ref_name?: (...) | (...);
                          ref_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          selector?: undefined;
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_schedule";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    cron_pattern?: string;
                    enabled?: boolean;
                    target?: {
                        type: "pipeline_ref_target";
                    } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        ref_name?: (...) | (...);
                        ref_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        selector?: undefined;
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The created schedule.

        • content: {
              application/json: {
                  type: "pipeline_schedule";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  cron_pattern?: string;
                  enabled?: boolean;
                  target?: {
                      type: "pipeline_ref_target";
                  } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      ref_name?: (...) | (...);
                      ref_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      selector?: undefined;
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_schedule";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                cron_pattern?: string;
                enabled?: boolean;
                target?: {
                    type: "pipeline_ref_target";
                } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    ref_name?: (...) | (...);
                    ref_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    selector?: undefined;
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created schedule.

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        There were errors validating the request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The maximum limit of schedules for this repository was reached.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_schedule_put_request_body";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a schedule

    Delete a schedule.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              schedule_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            schedule_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyschedule_uuid: string

          The uuid of the schedule.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The schedule was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or schedule was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a schedule

    Retrieve a schedule by its UUID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              schedule_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            schedule_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyschedule_uuid: string

          The uuid of the schedule.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_schedule";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      cron_pattern?: string;
                      enabled?: boolean;
                      target?: {
                          type: "pipeline_ref_target";
                      } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          ref_name?: (...) | (...);
                          ref_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          selector?: undefined;
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_schedule";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    cron_pattern?: string;
                    enabled?: boolean;
                    target?: {
                        type: "pipeline_ref_target";
                    } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        ref_name?: (...) | (...);
                        ref_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        selector?: undefined;
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requested schedule.

        • content: {
              application/json: {
                  type: "pipeline_schedule";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  cron_pattern?: string;
                  enabled?: boolean;
                  target?: {
                      type: "pipeline_ref_target";
                  } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      ref_name?: (...) | (...);
                      ref_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      selector?: undefined;
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_schedule";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                cron_pattern?: string;
                enabled?: boolean;
                target?: {
                    type: "pipeline_ref_target";
                } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    ref_name?: (...) | (...);
                    ref_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    selector?: undefined;
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or schedule was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_schedule_put_request_body";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    enabled?: boolean;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_schedule";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        cron_pattern?: string;
                        enabled?: boolean;
                        target?: {
                            type: "pipeline_ref_target";
                        } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            ref_name?: (...) | (...);
                            ref_type?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            selector?: undefined;
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a schedule

    Update a schedule.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              schedule_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            schedule_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyschedule_uuid: string

          The uuid of the schedule.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_schedule_put_request_body";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  enabled?: boolean;
              };
          };
      }

      The schedule to update.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_schedule_put_request_body";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                enabled?: boolean;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_schedule_put_request_body";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              enabled?: boolean;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_schedule";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      cron_pattern?: string;
                      enabled?: boolean;
                      target?: {
                          type: "pipeline_ref_target";
                      } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          ref_name?: (...) | (...);
                          ref_type?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          selector?: undefined;
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_schedule";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    cron_pattern?: string;
                    enabled?: boolean;
                    target?: {
                        type: "pipeline_ref_target";
                    } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        ref_name?: (...) | (...);
                        ref_type?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        selector?: undefined;
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The schedule is updated.

        • content: {
              application/json: {
                  type: "pipeline_schedule";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  cron_pattern?: string;
                  enabled?: boolean;
                  target?: {
                      type: "pipeline_ref_target";
                  } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      ref_name?: (...) | (...);
                      ref_type?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      selector?: undefined;
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_schedule";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                cron_pattern?: string;
                enabled?: boolean;
                target?: {
                    type: "pipeline_ref_target";
                } & Omit<(...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    ref_name?: (...) | (...);
                    ref_type?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    selector?: undefined;
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or schedule was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_schedule_execution";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                schedule_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_schedule_execution";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List executions of a schedule

    Retrieve the executions of a given schedule.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              schedule_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            schedule_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyschedule_uuid: string

          The uuid of the schedule.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_schedule_execution";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_schedule_execution";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of executions of a schedule.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_schedule_execution";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_schedule_execution";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_schedule_execution";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>)[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_ssh_key_pair";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        private_key?: string;
                        public_key?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_ssh_key_pair";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    private_key?: string;
                    public_key?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_ssh_key_pair";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        private_key?: string;
                        public_key?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete SSH key pair

    Delete the repository SSH key pair.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The SSH key pair was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or SSH key pair was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_ssh_key_pair";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        private_key?: string;
                        public_key?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get SSH key pair

    Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_ssh_key_pair";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      private_key?: string;
                      public_key?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_ssh_key_pair";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    private_key?: string;
                    public_key?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The SSH key pair.

        • content: {
              application/json: {
                  type: "pipeline_ssh_key_pair";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  private_key?: string;
                  public_key?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_ssh_key_pair";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                private_key?: string;
                public_key?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or SSH key pair was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_ssh_key_pair";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    private_key?: string;
                    public_key?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_ssh_key_pair";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        private_key?: string;
                        public_key?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update SSH key pair

    Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_ssh_key_pair";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  private_key?: string;
                  public_key?: string;
              };
          };
      }

      The created or updated SSH key pair.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_ssh_key_pair";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                private_key?: string;
                public_key?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_ssh_key_pair";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              private_key?: string;
              public_key?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_ssh_key_pair";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      private_key?: string;
                      public_key?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_ssh_key_pair";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    private_key?: string;
                    public_key?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The SSH key pair was created or updated.

        • content: {
              application/json: {
                  type: "pipeline_ssh_key_pair";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  private_key?: string;
                  public_key?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_ssh_key_pair";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                private_key?: string;
                public_key?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or SSH key pair was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_known_host";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            hostname?: (...) | (...);
                            public_key?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        key_type?: string;
                        md5_fingerprint?: string;
                        sha256_fingerprint?: string;
                    };
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_known_host";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            hostname?: (...) | (...);
                            public_key?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List known hosts

    Find repository level known hosts.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_known_host";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          hostname?: (...) | (...);
                          public_key?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_known_host";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        hostname?: (...) | (...);
                        public_key?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The retrieved known hosts.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_known_host";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      hostname?: (...) | (...);
                      public_key?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_known_host";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    hostname?: (...) | (...);
                    public_key?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_known_host";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  hostname?: (...) | (...);
                  public_key?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        key_type?: string;
                        md5_fingerprint?: string;
                        sha256_fingerprint?: string;
                    };
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a known host

    Create a repository level known host.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_known_host";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  hostname?: string;
                  public_key?: {
                      type: "pipeline_ssh_public_key";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      key_type?: string;
                      md5_fingerprint?: string;
                      sha256_fingerprint?: string;
                  };
                  uuid?: string;
              };
          };
      }

      The known host to create.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_known_host";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                hostname?: string;
                public_key?: {
                    type: "pipeline_ssh_public_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    key_type?: string;
                    md5_fingerprint?: string;
                    sha256_fingerprint?: string;
                };
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_known_host";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              hostname?: string;
              public_key?: {
                  type: "pipeline_ssh_public_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  key_type?: string;
                  md5_fingerprint?: string;
                  sha256_fingerprint?: string;
              };
              uuid?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_known_host";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      hostname?: string;
                      public_key?: {
                          type: "pipeline_ssh_public_key";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          key_type?: (...) | (...);
                          md5_fingerprint?: (...) | (...);
                          sha256_fingerprint?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        key_type?: (...) | (...);
                        md5_fingerprint?: (...) | (...);
                        sha256_fingerprint?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The known host was created.

        • content: {
              application/json: {
                  type: "pipeline_known_host";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  hostname?: string;
                  public_key?: {
                      type: "pipeline_ssh_public_key";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      key_type?: (...) | (...);
                      md5_fingerprint?: (...) | (...);
                      sha256_fingerprint?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_known_host";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                hostname?: string;
                public_key?: {
                    type: "pipeline_ssh_public_key";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    key_type?: (...) | (...);
                    md5_fingerprint?: (...) | (...);
                    sha256_fingerprint?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline known host.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A known host with the provided hostname already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        key_type?: string;
                        md5_fingerprint?: string;
                        sha256_fingerprint?: string;
                    };
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a known host

    Delete a repository level known host.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              known_host_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            known_host_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyknown_host_uuid: string

          The UUID of the known host to delete.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The known host was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or known host with given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a known host

    Retrieve a repository level known host.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              known_host_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            known_host_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyknown_host_uuid: string

          The UUID of the known host to retrieve.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_known_host";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      hostname?: string;
                      public_key?: {
                          type: "pipeline_ssh_public_key";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          key_type?: (...) | (...);
                          md5_fingerprint?: (...) | (...);
                          sha256_fingerprint?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        key_type?: (...) | (...);
                        md5_fingerprint?: (...) | (...);
                        sha256_fingerprint?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The known host.

        • content: {
              application/json: {
                  type: "pipeline_known_host";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  hostname?: string;
                  public_key?: {
                      type: "pipeline_ssh_public_key";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      key_type?: (...) | (...);
                      md5_fingerprint?: (...) | (...);
                      sha256_fingerprint?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_known_host";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                hostname?: string;
                public_key?: {
                    type: "pipeline_ssh_public_key";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    key_type?: (...) | (...);
                    md5_fingerprint?: (...) | (...);
                    sha256_fingerprint?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or known host with the specified UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                known_host_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        key_type?: string;
                        md5_fingerprint?: string;
                        sha256_fingerprint?: string;
                    };
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_known_host";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        hostname?: string;
                        public_key?: {
                            type: "pipeline_ssh_public_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            key_type?: (...) | (...);
                            md5_fingerprint?: (...) | (...);
                            sha256_fingerprint?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a known host

    Update a repository level known host.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              known_host_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            known_host_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyknown_host_uuid: string

          The UUID of the known host to update.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_known_host";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  hostname?: string;
                  public_key?: {
                      type: "pipeline_ssh_public_key";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      key_type?: string;
                      md5_fingerprint?: string;
                      sha256_fingerprint?: string;
                  };
                  uuid?: string;
              };
          };
      }

      The updated known host.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_known_host";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                hostname?: string;
                public_key?: {
                    type: "pipeline_ssh_public_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    key_type?: string;
                    md5_fingerprint?: string;
                    sha256_fingerprint?: string;
                };
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_known_host";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              hostname?: string;
              public_key?: {
                  type: "pipeline_ssh_public_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  key_type?: string;
                  md5_fingerprint?: string;
                  sha256_fingerprint?: string;
              };
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_known_host";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      hostname?: string;
                      public_key?: {
                          type: "pipeline_ssh_public_key";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          key_type?: (...) | (...);
                          md5_fingerprint?: (...) | (...);
                          sha256_fingerprint?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_known_host";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    hostname?: string;
                    public_key?: {
                        type: "pipeline_ssh_public_key";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        key_type?: (...) | (...);
                        md5_fingerprint?: (...) | (...);
                        sha256_fingerprint?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The known host was updated.

        • content: {
              application/json: {
                  type: "pipeline_known_host";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  hostname?: string;
                  public_key?: {
                      type: "pipeline_ssh_public_key";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      key_type?: (...) | (...);
                      md5_fingerprint?: (...) | (...);
                      sha256_fingerprint?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_known_host";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                hostname?: string;
                public_key?: {
                    type: "pipeline_ssh_public_key";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    key_type?: (...) | (...);
                    md5_fingerprint?: (...) | (...);
                    sha256_fingerprint?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or known host with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/variables: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List variables for a repository

    Find repository level variables.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_variable";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          secured?: (...) | (...) | (...);
                          uuid?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The retrieved variables.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a variable for a repository

    Create a repository level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }

      The variable to create.

      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The variable was created.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline variable.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A variable with the provided key already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a variable for a repository

    Delete a repository level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyvariable_uuid: string

          The UUID of the variable to delete.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or variable with given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a variable for a repository

    Retrieve a repository level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyvariable_uuid: string

          The UUID of the variable to retrieve.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or variable with the specified UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a variable for a repository

    Update a repository level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyvariable_uuid: string

          The UUID of the variable to update.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }

      The updated variable

      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was updated.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account, repository or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines-config/caches: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query: {
                name: string;
            };
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_cache";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            file_size_bytes?: (...) | (...);
                            key_hash?: (...) | (...);
                            name?: (...) | (...);
                            path?: (...) | (...);
                            pipeline_uuid?: (...) | (...);
                            step_uuid?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query: {
                name: string;
            };
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete caches

    Delete repository cache versions by name.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query: {
              name: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The account.

      • Readonlyquery: {
            name: string;
        }
        • Readonlyname: string

          The cache name.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The caches were deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace, repository or cache name was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_cache";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            file_size_bytes?: (...) | (...);
                            key_hash?: (...) | (...);
                            name?: (...) | (...);
                            path?: (...) | (...);
                            pipeline_uuid?: (...) | (...);
                            step_uuid?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List caches

    Retrieve the repository pipelines caches.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_cache";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          file_size_bytes?: (...) | (...);
                          key_hash?: (...) | (...);
                          name?: (...) | (...);
                          path?: (...) | (...);
                          pipeline_uuid?: (...) | (...);
                          step_uuid?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_cache";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        file_size_bytes?: (...) | (...);
                        key_hash?: (...) | (...);
                        name?: (...) | (...);
                        path?: (...) | (...);
                        pipeline_uuid?: (...) | (...);
                        step_uuid?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of caches for the given repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_cache";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      file_size_bytes?: (...) | (...);
                      key_hash?: (...) | (...);
                      name?: (...) | (...);
                      path?: (...) | (...);
                      pipeline_uuid?: (...) | (...);
                      step_uuid?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_cache";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    file_size_bytes?: (...) | (...);
                    key_hash?: (...) | (...);
                    name?: (...) | (...);
                    path?: (...) | (...);
                    pipeline_uuid?: (...) | (...);
                    step_uuid?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_cache";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  file_size_bytes?: (...) | (...);
                  key_hash?: (...) | (...);
                  name?: (...) | (...);
                  path?: (...) | (...);
                  pipeline_uuid?: (...) | (...);
                  step_uuid?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or repository was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                cache_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                cache_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a cache

    Delete a repository cache.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              cache_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            cache_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycache_uuid: string

          The UUID of the cache to delete.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The cache was deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace, repository or cache_uuid with given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                cache_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        uri?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                cache_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        uri?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get cache content URI

    Retrieve the URI of the content of the specified cache.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              cache_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            cache_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycache_uuid: string

          The UUID of the cache.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      uri?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    uri?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The cache content uri.

        • content: {
              application/json: {
                  uri?: string;
              };
          }
          • Readonlyapplication/json: {
                uri?: string;
            }
            • Optional Readonlyuri?: string

              Format: uri

              The uri for pipeline cache content.

        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace, repository or cache_uuid with given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        build_number?: number;
                        build_seconds_used?: number;
                        completed_on?: string;
                        configuration_sources?: readonly {
                            source: string;
                            uri: string;
                        }[];
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        links?: {
                            type: "pipelines_pipeline_links";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            self?: (...) | (...);
                            steps?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "pipeline_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        target?: {
                            type: "pipeline_target";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        trigger?: {
                            type: "pipeline_trigger";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                        variables?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            key?: ...;
                            secured?: ...;
                            uuid?: ...;
                            value?: ...;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        build_number?: number;
                        build_seconds_used?: number;
                        completed_on?: string;
                        configuration_sources?: readonly {
                            source: string;
                            uri: string;
                        }[];
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        links?: {
                            type: "pipelines_pipeline_links";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            self?: (...) | (...);
                            steps?: (...) | (...);
                        };
                        repository?: {
                            type: "repository";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            fork_policy?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            full_name?: (...) | (...);
                            has_issues?: (...) | (...) | (...);
                            has_wiki?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            language?: (...) | (...);
                            links?: (...) | (...);
                            mainbranch?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            project?: (...) | (...);
                            scm?: (...) | (...);
                            size?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        state?: {
                            type: "pipeline_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        target?: {
                            type: "pipeline_target";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        trigger?: {
                            type: "pipeline_trigger";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                        variables?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            key?: ...;
                            secured?: ...;
                            uuid?: ...;
                            value?: ...;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a pipeline

    Retrieve a specified pipeline

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The pipeline UUID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      build_number?: number;
                      build_seconds_used?: number;
                      completed_on?: string;
                      configuration_sources?: readonly {
                          source: string;
                          uri: string;
                      }[];
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      links?: {
                          type: "pipelines_pipeline_links";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          self?: (...) | (...);
                          steps?: (...) | (...);
                      };
                      repository?: {
                          type: "repository";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          fork_policy?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          full_name?: (...) | (...);
                          has_issues?: (...) | (...) | (...);
                          has_wiki?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          language?: (...) | (...);
                          links?: (...) | (...);
                          mainbranch?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          project?: (...) | (...);
                          scm?: (...) | (...);
                          size?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      state?: {
                          type: "pipeline_state";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      target?: {
                          type: "pipeline_target";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      trigger?: {
                          type: "pipeline_trigger";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      uuid?: string;
                      variables?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          key?: ...;
                          secured?: ...;
                          uuid?: ...;
                          value?: ...;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    build_number?: number;
                    build_seconds_used?: number;
                    completed_on?: string;
                    configuration_sources?: readonly {
                        source: string;
                        uri: string;
                    }[];
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    links?: {
                        type: "pipelines_pipeline_links";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        self?: (...) | (...);
                        steps?: (...) | (...);
                    };
                    repository?: {
                        type: "repository";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        fork_policy?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        full_name?: (...) | (...);
                        has_issues?: (...) | (...) | (...);
                        has_wiki?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        language?: (...) | (...);
                        links?: (...) | (...);
                        mainbranch?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        project?: (...) | (...);
                        scm?: (...) | (...);
                        size?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    state?: {
                        type: "pipeline_state";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    target?: {
                        type: "pipeline_target";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    trigger?: {
                        type: "pipeline_trigger";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    uuid?: string;
                    variables?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        key?: ...;
                        secured?: ...;
                        uuid?: ...;
                        value?: ...;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The pipeline.

        • content: {
              application/json: {
                  type: "pipeline";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  build_number?: number;
                  build_seconds_used?: number;
                  completed_on?: string;
                  configuration_sources?: readonly {
                      source: string;
                      uri: string;
                  }[];
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  links?: {
                      type: "pipelines_pipeline_links";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      self?: (...) | (...);
                      steps?: (...) | (...);
                  };
                  repository?: {
                      type: "repository";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      fork_policy?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      full_name?: (...) | (...);
                      has_issues?: (...) | (...) | (...);
                      has_wiki?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      language?: (...) | (...);
                      links?: (...) | (...);
                      mainbranch?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      project?: (...) | (...);
                      scm?: (...) | (...);
                      size?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  state?: {
                      type: "pipeline_state";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  target?: {
                      type: "pipeline_target";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  trigger?: {
                      type: "pipeline_trigger";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  uuid?: string;
                  variables?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      key?: ...;
                      secured?: ...;
                      uuid?: ...;
                      value?: ...;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                build_number?: number;
                build_seconds_used?: number;
                completed_on?: string;
                configuration_sources?: readonly {
                    source: string;
                    uri: string;
                }[];
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                links?: {
                    type: "pipelines_pipeline_links";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    self?: (...) | (...);
                    steps?: (...) | (...);
                };
                repository?: {
                    type: "repository";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    fork_policy?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    full_name?: (...) | (...);
                    has_issues?: (...) | (...) | (...);
                    has_wiki?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    language?: (...) | (...);
                    links?: (...) | (...);
                    mainbranch?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    parent?: ({ readonly type: "repository"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    project?: (...) | (...);
                    scm?: (...) | (...);
                    size?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                state?: {
                    type: "pipeline_state";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                target?: {
                    type: "pipeline_target";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                trigger?: {
                    type: "pipeline_trigger";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                uuid?: string;
                variables?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    key?: ...;
                    secured?: ...;
                    uuid?: ...;
                    value?: ...;
                })[];
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository or pipeline with the UUID provided exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_step";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            completed_on?: (...) | (...);
                            image?: (...) | (...);
                            script_commands?: (...) | (...);
                            setup_commands?: (...) | (...);
                            started_on?: (...) | (...);
                            state?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_step";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            completed_on?: (...) | (...);
                            image?: (...) | (...);
                            script_commands?: (...) | (...);
                            setup_commands?: (...) | (...);
                            started_on?: (...) | (...);
                            state?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List steps for a pipeline

    Find steps for the given pipeline.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_step";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          completed_on?: (...) | (...);
                          image?: (...) | (...);
                          script_commands?: (...) | (...);
                          setup_commands?: (...) | (...);
                          started_on?: (...) | (...);
                          state?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_step";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        completed_on?: (...) | (...);
                        image?: (...) | (...);
                        script_commands?: (...) | (...);
                        setup_commands?: (...) | (...);
                        started_on?: (...) | (...);
                        state?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The steps.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_step";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      completed_on?: (...) | (...);
                      image?: (...) | (...);
                      script_commands?: (...) | (...);
                      setup_commands?: (...) | (...);
                      started_on?: (...) | (...);
                      state?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_step";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    completed_on?: (...) | (...);
                    image?: (...) | (...);
                    script_commands?: (...) | (...);
                    setup_commands?: (...) | (...);
                    started_on?: (...) | (...);
                    state?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_step";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  completed_on?: (...) | (...);
                  image?: (...) | (...);
                  script_commands?: (...) | (...);
                  setup_commands?: (...) | (...);
                  started_on?: (...) | (...);
                  state?: (...) | (...);
                  uuid?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_step";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        completed_on?: string;
                        image?: {
                            email?: string;
                            name?: string;
                            password?: string;
                            username?: string;
                        };
                        script_commands?: readonly {
                            command?: (...) | (...);
                            name?: (...) | (...);
                        }[];
                        setup_commands?: readonly {
                            command?: (...) | (...);
                            name?: (...) | (...);
                        }[];
                        started_on?: string;
                        state?: {
                            type: "pipeline_step_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_step";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        completed_on?: string;
                        image?: {
                            email?: string;
                            name?: string;
                            password?: string;
                            username?: string;
                        };
                        script_commands?: readonly {
                            command?: (...) | (...);
                            name?: (...) | (...);
                        }[];
                        setup_commands?: readonly {
                            command?: (...) | (...);
                            name?: (...) | (...);
                        }[];
                        started_on?: string;
                        state?: {
                            type: "pipeline_step_state";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a step of a pipeline

    Retrieve a given step of a pipeline.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_step";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      completed_on?: string;
                      image?: {
                          email?: string;
                          name?: string;
                          password?: string;
                          username?: string;
                      };
                      script_commands?: readonly {
                          command?: (...) | (...);
                          name?: (...) | (...);
                      }[];
                      setup_commands?: readonly {
                          command?: (...) | (...);
                          name?: (...) | (...);
                      }[];
                      started_on?: string;
                      state?: {
                          type: "pipeline_step_state";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_step";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    completed_on?: string;
                    image?: {
                        email?: string;
                        name?: string;
                        password?: string;
                        username?: string;
                    };
                    script_commands?: readonly {
                        command?: (...) | (...);
                        name?: (...) | (...);
                    }[];
                    setup_commands?: readonly {
                        command?: (...) | (...);
                        name?: (...) | (...);
                    }[];
                    started_on?: string;
                    state?: {
                        type: "pipeline_step_state";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The step.

        • content: {
              application/json: {
                  type: "pipeline_step";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  completed_on?: string;
                  image?: {
                      email?: string;
                      name?: string;
                      password?: string;
                      username?: string;
                  };
                  script_commands?: readonly {
                      command?: (...) | (...);
                      name?: (...) | (...);
                  }[];
                  setup_commands?: readonly {
                      command?: (...) | (...);
                      name?: (...) | (...);
                  }[];
                  started_on?: string;
                  state?: {
                      type: "pipeline_step_state";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_step";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                completed_on?: string;
                image?: {
                    email?: string;
                    name?: string;
                    password?: string;
                    username?: string;
                };
                script_commands?: readonly {
                    command?: (...) | (...);
                    name?: (...) | (...);
                }[];
                setup_commands?: readonly {
                    command?: (...) | (...);
                    name?: (...) | (...);
                }[];
                started_on?: string;
                state?: {
                    type: "pipeline_step_state";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>>;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository, pipeline or step with the UUID provided exists for the pipeline with the UUID provided.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            304: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            416: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            304: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            416: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get log file for a step

    Retrieve the log file for a given step of a pipeline.

    This endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          304: {
              content: {
                  application/octet-stream: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/octet-stream: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          416: {
              content: {
                  application/octet-stream: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw log file for this pipeline step.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly304: {
            content: {
                application/octet-stream: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The log has the same etag as the provided If-None-Match header.

        • content: {
              application/octet-stream: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/octet-stream: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/octet-stream: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A pipeline with the given UUID does not exist, a step with the given UUID does not exist in the pipeline or a log file does not exist for the given step.

        • content: {
              application/octet-stream: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/octet-stream: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly416: {
            content: {
                application/octet-stream: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requested range does not exist for requests that specified the HTTP Range header.

        • content: {
              application/octet-stream: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/octet-stream: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                log_uuid: string;
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                log_uuid: string;
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/octet-stream: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the logs for the build container or a service container for a given step of a pipeline.

    Retrieve the log file for a build container or service container.

    This endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              log_uuid: string;
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            log_uuid: string;
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            workspace: string;
        }
        • Readonlylog_uuid: string

          For the main build container specify the step UUID; for a service container specify the service container UUID

        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/octet-stream: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw log file for the build container or service container.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/octet-stream: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository, pipeline, step or log exist for the provided path.

        • content: {
              application/octet-stream: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/octet-stream: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a summary of test reports for a given step of a pipeline.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        A summary of test reports for this pipeline step.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository, pipeline, step or test reports exist for the provided path.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get test cases for a given step of a pipeline.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Test cases for this pipeline step.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository, pipeline, step or test reports exist for the provided path.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                test_case_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                step_uuid: string;
                test_case_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get test case reasons (output) for a given test case in a step of a pipeline.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              step_uuid: string;
              test_case_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            step_uuid: string;
            test_case_uuid: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlystep_uuid: string

          The UUID of the step.

        • Readonlytest_case_uuid: string

          The UUID of the test case.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Test case reasons (output).

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No account, repository, pipeline, step or test case with the UUID provided exists for the pipeline with the UUID provided.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline: {
    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: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pipeline_uuid: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Stop a pipeline

    Signal the stop of a pipeline and all of its steps that not have completed yet.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pipeline_uuid: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pipeline_uuid: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypipeline_uuid: string

          The UUID of the pipeline.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The pipeline has been signaled to stop.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified pipeline has already completed.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Either the account, repository or pipeline with the given UUID does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a repository application property

    Delete an application property value stored against a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a repository application property

    Retrieve an application property value stored against a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      _attributes?: readonly ("public" | "read_only")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The value of the property.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a repository application property

    Update an application property value stored against a repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              _attributes?: readonly ("public" | "read_only")[];
          }
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List pull requests

    Returns all pull requests on the specified repository.

    By default only open pull requests are returned. This can be controlled
    using the `state` query parameter. To retrieve pull requests that are
    in one of multiple states, repeat the `state` parameter for each
    individual state.
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              state?:
                  | "DECLINED"
                  | "MERGED"
                  | "OPEN"
                  | "SUPERSEDED";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            state?:
                | "DECLINED"
                | "MERGED"
                | "OPEN"
                | "SUPERSEDED";
        }
        • Optional Readonlystate?:
              | "DECLINED"
              | "MERGED"
              | "OPEN"
              | "SUPERSEDED"

          Only return pull requests that are in this state. This parameter can be repeated.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All pull requests on the specified repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  close_source_branch?: (...) | (...) | (...);
                  closed_by?: (...) | (...);
                  comment_count?: (...) | (...);
                  created_on?: (...) | (...);
                  destination?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  merge_commit?: (...) | (...);
                  participants?: (...) | (...);
                  reason?: (...) | (...);
                  rendered?: (...) | (...);
                  reviewers?: (...) | (...);
                  source?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  task_count?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a pull request

    Creates a new pull request where the destination repository is this repository and the author is the authenticated user.

    The minimum required fields to create a pull request are `title` and
    `source`, specified by a branch name.
    
    ```
    curl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repository/pullrequests \
        -u my-username:my-password \
        --request POST \
        --header 'Content-Type: application/json' \
        --data '{
            "title": "My Title",
            "source": {
                "branch": {
                    "name": "staging"
                }
            }
        }'
    ```
    
    If the pull request's `destination` is not specified, it will default
    to the `repository.mainbranch`. To open a pull request to a
    different branch, say from a feature branch to a staging branch,
    specify a `destination` (same format as the `source`):
    
    ```
    {
        "title": "My Title",
        "source": {
            "branch": {
                "name": "my-feature-branch"
            }
        },
        "destination": {
            "branch": {
                "name": "staging"
            }
        }
    }
    ```
    
    Reviewers can be specified by adding an array of user objects as the
    `reviewers` property.
    
    ```
    {
        "title": "My Title",
        "source": {
            "branch": {
                "name": "my-feature-branch"
            }
        },
        "reviewers": [
            {
                "uuid": "{504c3b62-8120-4f0c-a7bc-87800b9d6f70}"
            }
        ]
    }
    ```
    
    Other fields:
    
    * `description` - a string
    * `close_source_branch` - boolean that specifies if the source branch should be closed upon merging
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          };
      }

      The new pull request.

      The request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request object if you want to pull from a different repository (fork).
      
      Since not all elements are required or even mutable, you only need to include the elements you want to initialize, such as the source branch and the title.
      
      • Readonlycontent: {
            application/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pullrequest";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              author?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              close_source_branch?: boolean;
              closed_by?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              comment_count?: number;
              created_on?: string;
              destination?: {
                  branch?: {
                      default_merge_strategy?: ...;
                      merge_strategies?: ...;
                      name?: ...;
                  };
                  commit?: {
                      hash?: ...;
                  };
                  repository?: (...) & (...) & (...) & (...);
              };
              id?: number;
              links?: {
                  activity?: {
                      href?: ...;
                      name?: ...;
                  };
                  approve?: {
                      href?: ...;
                      name?: ...;
                  };
                  comments?: {
                      href?: ...;
                      name?: ...;
                  };
                  commits?: {
                      href?: ...;
                      name?: ...;
                  };
                  decline?: {
                      href?: ...;
                      name?: ...;
                  };
                  diff?: {
                      href?: ...;
                      name?: ...;
                  };
                  diffstat?: {
                      href?: ...;
                      name?: ...;
                  };
                  html?: {
                      href?: ...;
                      name?: ...;
                  };
                  merge?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              merge_commit?: {
                  hash?: string;
              };
              participants?: readonly ({
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  approved?: ...;
                  participated_on?: ...;
                  role?: ...;
                  state?: ...;
                  user?: ...;
              })[];
              reason?: string;
              rendered?: {
                  description?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  reason?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  title?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
              };
              reviewers?: readonly ({
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              })[];
              source?: {
                  branch?: {
                      default_merge_strategy?: ...;
                      merge_strategies?: ...;
                      name?: ...;
                  };
                  commit?: {
                      hash?: ...;
                  };
                  repository?: (...) & (...) & (...) & (...);
              };
              state?:
                  | "DECLINED"
                  | "MERGED"
                  | "OPEN"
                  | "SUPERSEDED";
              summary?: {
                  html?: string;
                  markup?: "creole" | "markdown" | "plaintext";
                  raw?: string;
              };
              task_count?: number;
              title?: string;
              updated_on?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pullrequest";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      close_source_branch?: boolean;
                      closed_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      id?: number;
                      links?: {
                          activity?: {
                              href?: ...;
                              name?: ...;
                          };
                          approve?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          decline?: {
                              href?: ...;
                              name?: ...;
                          };
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          diffstat?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          merge?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      merge_commit?: {
                          hash?: string;
                      };
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      reason?: string;
                      rendered?: {
                          description?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          reason?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          title?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                      };
                      reviewers?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      source?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created pull request.

        • content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of new newly created pull request.

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a pull request

    Returns the specified pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      close_source_branch?: boolean;
                      closed_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      id?: number;
                      links?: {
                          activity?: {
                              href?: ...;
                              name?: ...;
                          };
                          approve?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          decline?: {
                              href?: ...;
                              name?: ...;
                          };
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          diffstat?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          merge?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      merge_commit?: {
                          hash?: string;
                      };
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      reason?: string;
                      rendered?: {
                          description?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          reason?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          title?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                      };
                      reviewers?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      source?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The pull request object

        • content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or pull request does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a pull request

    Mutates the specified pull request.

    This can be used to change the pull request's branches or description.
    
    Only open pull requests can be mutated.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          };
      }

      The pull request that is to be updated.

      • Readonlycontent: {
            application/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pullrequest";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              author?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              close_source_branch?: boolean;
              closed_by?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
              comment_count?: number;
              created_on?: string;
              destination?: {
                  branch?: {
                      default_merge_strategy?: ...;
                      merge_strategies?: ...;
                      name?: ...;
                  };
                  commit?: {
                      hash?: ...;
                  };
                  repository?: (...) & (...) & (...) & (...);
              };
              id?: number;
              links?: {
                  activity?: {
                      href?: ...;
                      name?: ...;
                  };
                  approve?: {
                      href?: ...;
                      name?: ...;
                  };
                  comments?: {
                      href?: ...;
                      name?: ...;
                  };
                  commits?: {
                      href?: ...;
                      name?: ...;
                  };
                  decline?: {
                      href?: ...;
                      name?: ...;
                  };
                  diff?: {
                      href?: ...;
                      name?: ...;
                  };
                  diffstat?: {
                      href?: ...;
                      name?: ...;
                  };
                  html?: {
                      href?: ...;
                      name?: ...;
                  };
                  merge?: {
                      href?: ...;
                      name?: ...;
                  };
                  self?: {
                      href?: ...;
                      name?: ...;
                  };
              };
              merge_commit?: {
                  hash?: string;
              };
              participants?: readonly ({
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  approved?: ...;
                  participated_on?: ...;
                  role?: ...;
                  state?: ...;
                  user?: ...;
              })[];
              reason?: string;
              rendered?: {
                  description?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  reason?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  title?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
              };
              reviewers?: readonly ({
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              })[];
              source?: {
                  branch?: {
                      default_merge_strategy?: ...;
                      merge_strategies?: ...;
                      name?: ...;
                  };
                  commit?: {
                      hash?: ...;
                  };
                  repository?: (...) & (...) & (...) & (...);
              };
              state?:
                  | "DECLINED"
                  | "MERGED"
                  | "OPEN"
                  | "SUPERSEDED";
              summary?: {
                  html?: string;
                  markup?: "creole" | "markdown" | "plaintext";
                  raw?: string;
              };
              task_count?: number;
              title?: string;
              updated_on?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      close_source_branch?: boolean;
                      closed_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      id?: number;
                      links?: {
                          activity?: {
                              href?: ...;
                              name?: ...;
                          };
                          approve?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          decline?: {
                              href?: ...;
                              name?: ...;
                          };
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          diffstat?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          merge?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      merge_commit?: {
                          hash?: string;
                      };
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      reason?: string;
                      rendered?: {
                          description?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          reason?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          title?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                      };
                      reviewers?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      source?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated pull request

        • content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the input document was invalid.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository or pull request id does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List a pull request activity log

    Returns a paginated list of the pull request's activity log.

    This handler serves both a v20 and internal endpoint. The v20 endpoint
    returns reviewer comments, updates, approvals and request changes. The internal
    endpoint includes those plus tasks and attachments.
    
    Comments created on a file or a line of code have an inline property.
    
    Comment example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "comment": {
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088"
                        }
                    },
                    "deleted": false,
                    "pullrequest": {
                        "type": "pullrequest",
                        "id": 5695,
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                            },
                            "html": {
                                "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                            }
                        },
                        "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                    },
                    "content": {
                        "raw": "inline with to a dn from lines",
                        "markup": "markdown",
                        "html": "<p>inline with to a dn from lines</p>",
                        "type": "rendered"
                    },
                    "created_on": "2019-09-27T00:33:46.039178+00:00",
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "created_on": "2019-09-27T00:33:46.039178+00:00",
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "updated_on": "2019-09-27T00:33:46.055384+00:00",
                    "inline": {
                        "context_lines": "",
                        "to": null,
                        "path": "",
                        "outdated": false,
                        "from": 211
                    },
                    "type": "pullrequest_comment",
                    "id": 118571088
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    Updates include a state property of OPEN, MERGED, or DECLINED.
    
    Update example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "update": {
                    "description": "",
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it",
                    "destination": {
                        "commit": {
                            "type": "commit",
                            "hash": "6a2c16e4a152",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152"
                                }
                            }
                        },
                        "branch": {
                            "name": "master"
                        },
                        "repository": {
                            "name": "Atlaskit-MK-2",
                            "type": "repository",
                            "full_name": "atlassian/atlaskit-mk-2",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2"
                                },
                                "avatar": {
                                    "href": "https://bytebucket.org/ravatar/%7B%7D?ts=js"
                                }
                            },
                            "uuid": "{}"
                        }
                    },
                    "reason": "",
                    "source": {
                        "commit": {
                            "type": "commit",
                            "hash": "728c8bad1813",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813"
                                }
                            }
                        },
                        "branch": {
                            "name": "username/NONE-add-onClick-prop-for-accessibility"
                        },
                        "repository": {
                            "name": "Atlaskit-MK-2",
                            "type": "repository",
                            "full_name": "atlassian/atlaskit-mk-2",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2"
                                },
                                "avatar": {
                                    "href": "https://bytebucket.org/ravatar/%7B%7D?ts=js"
                                }
                            },
                            "uuid": "{}"
                        }
                    },
                    "state": "OPEN",
                    "author": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "date": "2019-05-10T06:48:25.305565+00:00"
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    Approval example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "approval": {
                    "date": "2019-09-27T00:37:19.849534+00:00",
                    "pullrequest": {
                        "type": "pullrequest",
                        "id": 5695,
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                            },
                            "html": {
                                "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                            }
                        },
                        "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                    },
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    }
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The pull request activity log

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Unapprove a pull request

    Redact the authenticated user's approval of the specified pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response indicating the authenticated user's approval has been withdrawn.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Pull request cannot be unapproved because the pull request has already been merged.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified pull request or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Approve a pull request

    Approve the specified pull request as the authenticated user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "participant";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      approved?: boolean;
                      participated_on?: string;
                      role?: "PARTICIPANT" | "REVIEWER";
                      state?: null | "approved" | "changes_requested";
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "participant";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    approved?: boolean;
                    participated_on?: string;
                    role?: "PARTICIPANT" | "REVIEWER";
                    state?: null | "approved" | "changes_requested";
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The participant object recording that the authenticated user approved the pull request.

        • content: {
              application/json: {
                  type: "participant";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  approved?: boolean;
                  participated_on?: string;
                  role?: "PARTICIPANT" | "REVIEWER";
                  state?: null | "approved" | "changes_requested";
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "participant";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                approved?: boolean;
                participated_on?: string;
                role?: "PARTICIPANT" | "REVIEWER";
                state?: null | "approved" | "changes_requested";
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified pull request or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            pending?: (...) | (...) | (...);
                            pullrequest?: (...) | (...);
                            resolution?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        close_source_branch?: boolean;
                        closed_by?: (...) & (...) & (...) & (...);
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        id?: number;
                        links?: {
                            activity?: ...;
                            approve?: ...;
                            comments?: ...;
                            commits?: ...;
                            decline?: ...;
                            diff?: ...;
                            diffstat?: ...;
                            html?: ...;
                            merge?: ...;
                            self?: ...;
                        };
                        merge_commit?: {
                            hash?: ...;
                        };
                        participants?: readonly (...)[];
                        reason?: string;
                        rendered?: {
                            description?: ...;
                            reason?: ...;
                            title?: ...;
                        };
                        reviewers?: readonly (...)[];
                        source?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                    resolution?: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest_comment";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            pending?: (...) | (...) | (...);
                            pullrequest?: (...) | (...);
                            resolution?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List comments on a pull request

    Returns a paginated list of the pull request's comments.

    This includes both global, inline comments and replies.
    
    The default sorting is oldest to newest and can be overridden with
    the `sort` query parameter.
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more
    details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest_comment";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          pending?: (...) | (...) | (...);
                          pullrequest?: (...) | (...);
                          resolution?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest_comment";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        pending?: (...) | (...) | (...);
                        pullrequest?: (...) | (...);
                        resolution?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of comments made on the given pull request, in chronological order.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest_comment";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      pending?: (...) | (...) | (...);
                      pullrequest?: (...) | (...);
                      resolution?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest_comment";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    pending?: (...) | (...) | (...);
                    pullrequest?: (...) | (...);
                    resolution?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest_comment";
              } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  pending?: (...) | (...) | (...);
                  pullrequest?: (...) | (...);
                  resolution?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the pull request does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        close_source_branch?: boolean;
                        closed_by?: (...) & (...) & (...) & (...);
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        id?: number;
                        links?: {
                            activity?: ...;
                            approve?: ...;
                            comments?: ...;
                            commits?: ...;
                            decline?: ...;
                            diff?: ...;
                            diffstat?: ...;
                            html?: ...;
                            merge?: ...;
                            self?: ...;
                        };
                        merge_commit?: {
                            hash?: ...;
                        };
                        participants?: readonly (...)[];
                        reason?: string;
                        rendered?: {
                            description?: ...;
                            reason?: ...;
                            title?: ...;
                        };
                        reviewers?: readonly (...)[];
                        source?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                    resolution?: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a comment on a pull request

    Creates a new pull request comment.

    Returns the newly created pull request comment.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pullrequest_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  pending?: boolean;
                  pullrequest?: {
                      type: "pullrequest";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: (...) & (...) & (...) & (...);
                      close_source_branch?: boolean;
                      closed_by?: (...) & (...) & (...) & (...);
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: ...;
                          commit?: ...;
                          repository?: ...;
                      };
                      id?: number;
                      links?: {
                          activity?: ...;
                          approve?: ...;
                          comments?: ...;
                          commits?: ...;
                          decline?: ...;
                          diff?: ...;
                          diffstat?: ...;
                          html?: ...;
                          merge?: ...;
                          self?: ...;
                      };
                      merge_commit?: {
                          hash?: ...;
                      };
                      participants?: readonly (...)[];
                      reason?: string;
                      rendered?: {
                          description?: ...;
                          reason?: ...;
                          title?: ...;
                      };
                      reviewers?: readonly (...)[];
                      source?: {
                          branch?: ...;
                          commit?: ...;
                          repository?: ...;
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
                  resolution?: Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      type: string;
                      user?: (...) & (...) & (...) & (...);
                  };
              };
          };
      }

      The comment object.

      • Readonlycontent: {
            application/json: {
                type: "pullrequest_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                pending?: boolean;
                pullrequest?: {
                    type: "pullrequest";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: (...) & (...) & (...) & (...);
                    close_source_branch?: boolean;
                    closed_by?: (...) & (...) & (...) & (...);
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: ...;
                        commit?: ...;
                        repository?: ...;
                    };
                    id?: number;
                    links?: {
                        activity?: ...;
                        approve?: ...;
                        comments?: ...;
                        commits?: ...;
                        decline?: ...;
                        diff?: ...;
                        diffstat?: ...;
                        html?: ...;
                        merge?: ...;
                        self?: ...;
                    };
                    merge_commit?: {
                        hash?: ...;
                    };
                    participants?: readonly (...)[];
                    reason?: string;
                    rendered?: {
                        description?: ...;
                        reason?: ...;
                        title?: ...;
                    };
                    reviewers?: readonly (...)[];
                    source?: {
                        branch?: ...;
                        commit?: ...;
                        repository?: ...;
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
                resolution?: Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    type: string;
                    user?: (...) & (...) & (...) & (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "pullrequest_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              pending?: boolean;
              pullrequest?: {
                  type: "pullrequest";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: (...) & (...) & (...) & (...);
                  close_source_branch?: boolean;
                  closed_by?: (...) & (...) & (...) & (...);
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: ...;
                      commit?: ...;
                      repository?: ...;
                  };
                  id?: number;
                  links?: {
                      activity?: ...;
                      approve?: ...;
                      comments?: ...;
                      commits?: ...;
                      decline?: ...;
                      diff?: ...;
                      diffstat?: ...;
                      html?: ...;
                      merge?: ...;
                      self?: ...;
                  };
                  merge_commit?: {
                      hash?: ...;
                  };
                  participants?: readonly (...)[];
                  reason?: string;
                  rendered?: {
                      description?: ...;
                      reason?: ...;
                      title?: ...;
                  };
                  reviewers?: readonly (...)[];
                  source?: {
                      branch?: ...;
                      commit?: ...;
                      repository?: ...;
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
              resolution?: Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  type: string;
                  user?: (...) & (...) & (...) & (...);
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pullrequest_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      pending?: boolean;
                      pullrequest?: {
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                      resolution?: Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      };
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                    resolution?: Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    };
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created comment.

        • content: {
              application/json: {
                  type: "pullrequest_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  pending?: boolean;
                  pullrequest?: {
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
                  resolution?: Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                pending?: boolean;
                pullrequest?: {
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
                resolution?: Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                };
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the new comment

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the pull request does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        close_source_branch?: boolean;
                        closed_by?: (...) & (...) & (...) & (...);
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        id?: number;
                        links?: {
                            activity?: ...;
                            approve?: ...;
                            comments?: ...;
                            commits?: ...;
                            decline?: ...;
                            diff?: ...;
                            diffstat?: ...;
                            html?: ...;
                            merge?: ...;
                            self?: ...;
                        };
                        merge_commit?: {
                            hash?: ...;
                        };
                        participants?: readonly (...)[];
                        reason?: string;
                        rendered?: {
                            description?: ...;
                            reason?: ...;
                            title?: ...;
                        };
                        reviewers?: readonly (...)[];
                        source?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                    resolution?: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a comment on a pull request

    Deletes a specific pull request comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful deletion.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to delete the comment.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a comment on a pull request

    Returns a specific pull request comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      pending?: boolean;
                      pullrequest?: {
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                      resolution?: Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                    resolution?: Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The comment.

        • content: {
              application/json: {
                  type: "pullrequest_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  pending?: boolean;
                  pullrequest?: {
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
                  resolution?: Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                pending?: boolean;
                pullrequest?: {
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
                resolution?: Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          comment_id: number;
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycomment_id: number

        The id of the comment.

      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        close_source_branch?: boolean;
                        closed_by?: (...) & (...) & (...) & (...);
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        id?: number;
                        links?: {
                            activity?: ...;
                            approve?: ...;
                            comments?: ...;
                            commits?: ...;
                            decline?: ...;
                            diff?: ...;
                            diffstat?: ...;
                            html?: ...;
                            merge?: ...;
                            self?: ...;
                        };
                        merge_commit?: {
                            hash?: ...;
                        };
                        participants?: readonly (...)[];
                        reason?: string;
                        rendered?: {
                            description?: ...;
                            reason?: ...;
                            title?: ...;
                        };
                        reviewers?: readonly (...)[];
                        source?: {
                            branch?: ...;
                            commit?: ...;
                            repository?: ...;
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                    resolution?: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest_comment";
                    } & Omit<{
                        type: "comment";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: ...;
                            path: ...;
                            to?: ...;
                        };
                        links?: {
                            code?: ...;
                            html?: ...;
                            self?: ...;
                        };
                        parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                        updated_on?: string;
                        user?: (...) & (...) & (...) & (...);
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        pending?: boolean;
                        pullrequest?: {
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                        resolution?: Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a comment on a pull request

    Updates a specific pull request comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pullrequest_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  pending?: boolean;
                  pullrequest?: {
                      type: "pullrequest";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: (...) & (...) & (...) & (...);
                      close_source_branch?: boolean;
                      closed_by?: (...) & (...) & (...) & (...);
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: ...;
                          commit?: ...;
                          repository?: ...;
                      };
                      id?: number;
                      links?: {
                          activity?: ...;
                          approve?: ...;
                          comments?: ...;
                          commits?: ...;
                          decline?: ...;
                          diff?: ...;
                          diffstat?: ...;
                          html?: ...;
                          merge?: ...;
                          self?: ...;
                      };
                      merge_commit?: {
                          hash?: ...;
                      };
                      participants?: readonly (...)[];
                      reason?: string;
                      rendered?: {
                          description?: ...;
                          reason?: ...;
                          title?: ...;
                      };
                      reviewers?: readonly (...)[];
                      source?: {
                          branch?: ...;
                          commit?: ...;
                          repository?: ...;
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
                  resolution?: Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      type: string;
                      user?: (...) & (...) & (...) & (...);
                  };
              };
          };
      }

      The contents of the updated comment.

      • Readonlycontent: {
            application/json: {
                type: "pullrequest_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                pending?: boolean;
                pullrequest?: {
                    type: "pullrequest";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: (...) & (...) & (...) & (...);
                    close_source_branch?: boolean;
                    closed_by?: (...) & (...) & (...) & (...);
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: ...;
                        commit?: ...;
                        repository?: ...;
                    };
                    id?: number;
                    links?: {
                        activity?: ...;
                        approve?: ...;
                        comments?: ...;
                        commits?: ...;
                        decline?: ...;
                        diff?: ...;
                        diffstat?: ...;
                        html?: ...;
                        merge?: ...;
                        self?: ...;
                    };
                    merge_commit?: {
                        hash?: ...;
                    };
                    participants?: readonly (...)[];
                    reason?: string;
                    rendered?: {
                        description?: ...;
                        reason?: ...;
                        title?: ...;
                    };
                    reviewers?: readonly (...)[];
                    source?: {
                        branch?: ...;
                        commit?: ...;
                        repository?: ...;
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
                resolution?: Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    type: string;
                    user?: (...) & (...) & (...) & (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "pullrequest_comment";
          } & Omit<{
              type: "comment";
          } & Omit<Readonly<Record<(...), (...)>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              content?: {
                  html?: (...) | (...);
                  markup?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  raw?: (...) | (...);
              };
              created_on?: string;
              deleted?: boolean;
              id?: number;
              inline?: {
                  from?: (...) | (...);
                  path: string;
                  to?: (...) | (...);
              };
              links?: {
                  code?: (...) | (...);
                  html?: (...) | (...);
                  self?: (...) | (...);
              };
              parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
              updated_on?: string;
              user?: {
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              };
          }, "type"> & Readonly<Record<string, unknown>> & {
              pending?: boolean;
              pullrequest?: {
                  type: "pullrequest";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: (...) & (...) & (...) & (...);
                  close_source_branch?: boolean;
                  closed_by?: (...) & (...) & (...) & (...);
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: ...;
                      commit?: ...;
                      repository?: ...;
                  };
                  id?: number;
                  links?: {
                      activity?: ...;
                      approve?: ...;
                      comments?: ...;
                      commits?: ...;
                      decline?: ...;
                      diff?: ...;
                      diffstat?: ...;
                      html?: ...;
                      merge?: ...;
                      self?: ...;
                  };
                  merge_commit?: {
                      hash?: ...;
                  };
                  participants?: readonly (...)[];
                  reason?: string;
                  rendered?: {
                      description?: ...;
                      reason?: ...;
                      title?: ...;
                  };
                  reviewers?: readonly (...)[];
                  source?: {
                      branch?: ...;
                      commit?: ...;
                      repository?: ...;
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
              resolution?: Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  type: string;
                  user?: (...) & (...) & (...) & (...);
              };
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest_comment";
                  } & Omit<{
                      type: "comment";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: ...;
                          path: ...;
                          to?: ...;
                      };
                      links?: {
                          code?: ...;
                          html?: ...;
                          self?: ...;
                      };
                      parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                      updated_on?: string;
                      user?: (...) & (...) & (...) & (...);
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      pending?: boolean;
                      pullrequest?: {
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                      resolution?: Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest_comment";
                } & Omit<{
                    type: "comment";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: ...;
                        path: ...;
                        to?: ...;
                    };
                    links?: {
                        code?: ...;
                        html?: ...;
                        self?: ...;
                    };
                    parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                    updated_on?: string;
                    user?: (...) & (...) & (...) & (...);
                }, "type"> & Readonly<Record<string, unknown>> & {
                    pending?: boolean;
                    pullrequest?: {
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                    resolution?: Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated comment.

        • content: {
              application/json: {
                  type: "pullrequest_comment";
              } & Omit<{
                  type: "comment";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: ...;
                      path: ...;
                      to?: ...;
                  };
                  links?: {
                      code?: ...;
                      html?: ...;
                      self?: ...;
                  };
                  parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                  updated_on?: string;
                  user?: (...) & (...) & (...) & (...);
              }, "type"> & Readonly<Record<string, unknown>> & {
                  pending?: boolean;
                  pullrequest?: {
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
                  resolution?: Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest_comment";
            } & Omit<{
                type: "comment";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: ...;
                    path: ...;
                    to?: ...;
                };
                links?: {
                    code?: ...;
                    html?: ...;
                    self?: ...;
                };
                parent?: { readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; };
                updated_on?: string;
                user?: (...) & (...) & (...) & (...);
            }, "type"> & Readonly<Record<string, unknown>> & {
                pending?: boolean;
                pullrequest?: {
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
                resolution?: Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the comment.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Reopen a comment thread

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The comment is reopened.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request, or if the provided comment is not a top-level comment.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment does not exist, or if the comment has not been resolved

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          comment_id: number;
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycomment_id: number

        The id of the comment.

      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        type: string;
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Resolve a comment thread

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      type: string;
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    type: string;
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The comment resolution details.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  type: string;
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                created_on?: string;
                type: string;
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request, if the provided comment is not a top-level comment, or if the comment is not on the diff.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment has already been resolved.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commits on a pull request

    Returns a paginated list of the pull request's commits.

    These are the commits that are being merged into the destination
    branch when the pull requests gets accepted.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of commits made on the given pull request, in chronological order. This list will be empty if the source branch no longer exists.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the pull request does not exist or the source branch is from a forked repository which no longer exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Decline a pull request

    Declines the pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      close_source_branch?: boolean;
                      closed_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      id?: number;
                      links?: {
                          activity?: {
                              href?: ...;
                              name?: ...;
                          };
                          approve?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          decline?: {
                              href?: ...;
                              name?: ...;
                          };
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          diffstat?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          merge?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      merge_commit?: {
                          hash?: string;
                      };
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      reason?: string;
                      rendered?: {
                          description?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          reason?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          title?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                      };
                      reviewers?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      source?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The pull request was successfully declined.

        • content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the decline took too long and timed out. In this case the caller should retry the request later.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List changes in a pull request

    Redirects to the repository diff with the revspec that corresponds to the pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Redirects to the repository diff with the revspec that corresponds to the pull request.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the diff stat for a pull request

    Redirects to the repository diffstat with the revspec that corresponds to the pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Redirects to the repository diffstat with the revspec that corresponds to pull request.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                async?: boolean;
            };
        };
        requestBody?: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    close_source_branch?: boolean;
                    merge_strategy?: "fast_forward" | "merge_commit" | "squash";
                    message?: string;
                    type: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                async?: boolean;
            };
        };
        requestBody?: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    close_source_branch?: boolean;
                    merge_strategy?: "fast_forward" | "merge_commit" | "squash";
                    message?: string;
                    type: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pullrequest";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        close_source_branch?: boolean;
                        closed_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        comment_count?: number;
                        created_on?: string;
                        destination?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        id?: number;
                        links?: {
                            activity?: {
                                href?: ...;
                                name?: ...;
                            };
                            approve?: {
                                href?: ...;
                                name?: ...;
                            };
                            comments?: {
                                href?: ...;
                                name?: ...;
                            };
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            decline?: {
                                href?: ...;
                                name?: ...;
                            };
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            diffstat?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            merge?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        merge_commit?: {
                            hash?: string;
                        };
                        participants?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            approved?: ...;
                            participated_on?: ...;
                            role?: ...;
                            state?: ...;
                            user?: ...;
                        })[];
                        reason?: string;
                        rendered?: {
                            description?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            reason?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            title?: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                        };
                        reviewers?: readonly ({
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        })[];
                        source?: {
                            branch?: {
                                default_merge_strategy?: ...;
                                merge_strategies?: ...;
                                name?: ...;
                            };
                            commit?: {
                                hash?: ...;
                            };
                            repository?: (...) & (...) & (...) & (...);
                        };
                        state?:
                            | "DECLINED"
                            | "MERGED"
                            | "OPEN"
                            | "SUPERSEDED";
                        summary?: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        task_count?: number;
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            202: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Merge a pull request

    Merges the pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              async?: boolean;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            async?: boolean;
        }
        • Optional Readonlyasync?: boolean

          Default value is false.

          When set to true, runs merge asynchronously and
          immediately returns a 202 with polling link to
          the task-status API in the Location header.
          
          
          When set to false, runs merge and waits for it to
          complete, returning 200 when it succeeds. If the
          duration of the merge exceeds a timeout threshold,
          the API returns a 202 with polling link to the
          task-status API in the Location header.
          
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  close_source_branch?: boolean;
                  merge_strategy?: "fast_forward" | "merge_commit" | "squash";
                  message?: string;
                  type: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                close_source_branch?: boolean;
                merge_strategy?: "fast_forward" | "merge_commit" | "squash";
                message?: string;
                type: string;
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              close_source_branch?: boolean;
              merge_strategy?: "fast_forward" | "merge_commit" | "squash";
              message?: string;
              type: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pullrequest";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      close_source_branch?: boolean;
                      closed_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      comment_count?: number;
                      created_on?: string;
                      destination?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      id?: number;
                      links?: {
                          activity?: {
                              href?: ...;
                              name?: ...;
                          };
                          approve?: {
                              href?: ...;
                              name?: ...;
                          };
                          comments?: {
                              href?: ...;
                              name?: ...;
                          };
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          decline?: {
                              href?: ...;
                              name?: ...;
                          };
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          diffstat?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          merge?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      merge_commit?: {
                          hash?: string;
                      };
                      participants?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          approved?: ...;
                          participated_on?: ...;
                          role?: ...;
                          state?: ...;
                          user?: ...;
                      })[];
                      reason?: string;
                      rendered?: {
                          description?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          reason?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          title?: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                      };
                      reviewers?: readonly ({
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      })[];
                      source?: {
                          branch?: {
                              default_merge_strategy?: ...;
                              merge_strategies?: ...;
                              name?: ...;
                          };
                          commit?: {
                              hash?: ...;
                          };
                          repository?: (...) & (...) & (...) & (...);
                      };
                      state?:
                          | "DECLINED"
                          | "MERGED"
                          | "OPEN"
                          | "SUPERSEDED";
                      summary?: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      task_count?: number;
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          202: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pullrequest";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    close_source_branch?: boolean;
                    closed_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    comment_count?: number;
                    created_on?: string;
                    destination?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    id?: number;
                    links?: {
                        activity?: {
                            href?: ...;
                            name?: ...;
                        };
                        approve?: {
                            href?: ...;
                            name?: ...;
                        };
                        comments?: {
                            href?: ...;
                            name?: ...;
                        };
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        decline?: {
                            href?: ...;
                            name?: ...;
                        };
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        diffstat?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        merge?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    merge_commit?: {
                        hash?: string;
                    };
                    participants?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        approved?: ...;
                        participated_on?: ...;
                        role?: ...;
                        state?: ...;
                        user?: ...;
                    })[];
                    reason?: string;
                    rendered?: {
                        description?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        reason?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        title?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    };
                    reviewers?: readonly ({
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    })[];
                    source?: {
                        branch?: {
                            default_merge_strategy?: ...;
                            merge_strategies?: ...;
                            name?: ...;
                        };
                        commit?: {
                            hash?: ...;
                        };
                        repository?: (...) & (...) & (...) & (...);
                    };
                    state?:
                        | "DECLINED"
                        | "MERGED"
                        | "OPEN"
                        | "SUPERSEDED";
                    summary?: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    task_count?: number;
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The pull request object.

        • content: {
              application/json: {
                  type: "pullrequest";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  close_source_branch?: boolean;
                  closed_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  comment_count?: number;
                  created_on?: string;
                  destination?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  id?: number;
                  links?: {
                      activity?: {
                          href?: ...;
                          name?: ...;
                      };
                      approve?: {
                          href?: ...;
                          name?: ...;
                      };
                      comments?: {
                          href?: ...;
                          name?: ...;
                      };
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      decline?: {
                          href?: ...;
                          name?: ...;
                      };
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      diffstat?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      merge?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  merge_commit?: {
                      hash?: string;
                  };
                  participants?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      approved?: ...;
                      participated_on?: ...;
                      role?: ...;
                      state?: ...;
                      user?: ...;
                  })[];
                  reason?: string;
                  rendered?: {
                      description?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      reason?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      title?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  };
                  reviewers?: readonly ({
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  })[];
                  source?: {
                      branch?: {
                          default_merge_strategy?: ...;
                          merge_strategies?: ...;
                          name?: ...;
                      };
                      commit?: {
                          hash?: ...;
                      };
                      repository?: (...) & (...) & (...) & (...);
                  };
                  state?:
                      | "DECLINED"
                      | "MERGED"
                      | "OPEN"
                      | "SUPERSEDED";
                  summary?: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  task_count?: number;
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pullrequest";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                close_source_branch?: boolean;
                closed_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                comment_count?: number;
                created_on?: string;
                destination?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                id?: number;
                links?: {
                    activity?: {
                        href?: ...;
                        name?: ...;
                    };
                    approve?: {
                        href?: ...;
                        name?: ...;
                    };
                    comments?: {
                        href?: ...;
                        name?: ...;
                    };
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    decline?: {
                        href?: ...;
                        name?: ...;
                    };
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    diffstat?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    merge?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                merge_commit?: {
                    hash?: string;
                };
                participants?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    approved?: ...;
                    participated_on?: ...;
                    role?: ...;
                    state?: ...;
                    user?: ...;
                })[];
                reason?: string;
                rendered?: {
                    description?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    reason?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    title?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                };
                reviewers?: readonly ({
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                })[];
                source?: {
                    branch?: {
                        default_merge_strategy?: ...;
                        merge_strategies?: ...;
                        name?: ...;
                    };
                    commit?: {
                        hash?: ...;
                    };
                    repository?: (...) & (...) & (...) & (...);
                };
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
                summary?: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                task_count?: number;
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly202: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        In the Location header, the URL to poll for the pull request merge status

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the merge took too long and timed out. In this case the caller should retry the request later

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            task_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the merge task status for a pull request

    When merging a pull request takes too long, the client receives a task ID along with a 202 status code. The task ID can be used in a call to this endpoint to check the status of a merge task.

    ```
    curl -X GET https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/<task_id>
    ```
    
    If the merge task is not yet finished, a PENDING status will be returned.
    
    ```
    HTTP/2 200
    {
        "task_status": "PENDING",
        "links": {
            "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/<task_id>"
            }
        }
    }
    ```
    
    If the merge was successful, a SUCCESS status will be returned.
    
    ```
    HTTP/2 200
    {
        "task_status": "SUCCESS",
        "links": {
            "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/<task_id>"
            }
        },
        "merge_result": <the merged pull request object>
    }
    ```
    
    If the merge task failed, an error will be returned.
    
    ```
    {
        "type": "error",
        "error": {
            "message": "<error message>"
        }
    }
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              task_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            task_id: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytask_id: string

          ID of the merge task

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Returns a task status if the merge is either pending or successful, and if it is successful, a pull request

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the provided task ID does not relate to this pull request, or if something went wrong during the merge operation

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The user making the request does not have permission to the repo and is different from the user who queued the task

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            task_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          task_id: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlytask_id: string

        ID of the merge task

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the patch for a pull request

    Redirects to the repository patch with the revspec that corresponds to pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Redirects to the repository patch with the revspec that corresponds to pull request.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Remove change request for a pull request

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response indicating the authenticated user's request for change has been withdrawn.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Pull request requested changes cannot be removed because the pull request has already been merged.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified pull request or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyget?: undefined
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "participant";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        approved?: boolean;
                        participated_on?: string;
                        role?: "PARTICIPANT" | "REVIEWER";
                        state?: null | "approved" | "changes_requested";
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Request changes for a pull request

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "participant";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      approved?: boolean;
                      participated_on?: string;
                      role?: "PARTICIPANT" | "REVIEWER";
                      state?: null | "approved" | "changes_requested";
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "participant";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    approved?: boolean;
                    participated_on?: string;
                    role?: "PARTICIPANT" | "REVIEWER";
                    state?: null | "approved" | "changes_requested";
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The participant object recording that the authenticated user requested changes on the pull request.

        • content: {
              application/json: {
                  type: "participant";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  approved?: boolean;
                  participated_on?: string;
                  role?: "PARTICIPANT" | "REVIEWER";
                  state?: null | "approved" | "changes_requested";
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "participant";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                approved?: boolean;
                participated_on?: string;
                role?: "PARTICIPANT" | "REVIEWER";
                state?: null | "approved" | "changes_requested";
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Pull request changes cannot be requested because the pull request has already been merged.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified pull request or the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commitstatus";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            refname?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            updated_on?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "commitstatus";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            refname?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            updated_on?: (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List commit statuses for a pull request

    Returns all statuses (e.g. build results) for the given pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. Defaults to created_on.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "commitstatus";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          refname?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          updated_on?: (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "commitstatus";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        refname?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        updated_on?: (...) | (...);
                        url?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of all commit statuses for this pull request.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "commitstatus";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      refname?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      updated_on?: (...) | (...);
                      url?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "commitstatus";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    refname?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    updated_on?: (...) | (...);
                    url?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "commitstatus";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  refname?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  updated_on?: (...) | (...);
                  url?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository or pull request does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                pagelen?: number;
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            content: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on: string;
                            creator: (...) & (...) & (...) & (...);
                            id?: (...) | (...);
                            pending?: (...) | (...) | (...);
                            resolved_by?: (...) | (...);
                            resolved_on?: (...) | (...);
                            state: (...) | (...);
                            updated_on: string;
                        } & {
                            links?: (...) | (...);
                        } & {
                            comment?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    comment?: {
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    };
                    content: {
                        raw: string;
                    };
                    pending?: boolean;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                pagelen?: number;
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            content: {
                                html?: ...;
                                markup?: ...;
                                raw?: ...;
                            };
                            created_on: string;
                            creator: (...) & (...) & (...) & (...);
                            id?: (...) | (...);
                            pending?: (...) | (...) | (...);
                            resolved_by?: (...) | (...);
                            resolved_on?: (...) | (...);
                            state: (...) | (...);
                            updated_on: string;
                        } & {
                            links?: (...) | (...);
                        } & {
                            comment?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List tasks on a pull request

    Returns a paginated list of the pull request's tasks.

    This endpoint supports filtering and sorting of the results by the 'task' field.
    See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              pagelen?: number;
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            pagelen?: number;
            q?: string;
            sort?: string;
        }
        • Optional Readonlypagelen?: number

          Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

        • Optional Readonlyq?: string

          Query string to narrow down the response. See filtering and sorting for details.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. Defaults to created_on.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          content: {
                              html?: ...;
                              markup?: ...;
                              raw?: ...;
                          };
                          created_on: string;
                          creator: (...) & (...) & (...) & (...);
                          id?: (...) | (...);
                          pending?: (...) | (...) | (...);
                          resolved_by?: (...) | (...);
                          resolved_on?: (...) | (...);
                          state: (...) | (...);
                          updated_on: string;
                      } & {
                          links?: (...) | (...);
                      } & {
                          comment?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        content: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                        created_on: string;
                        creator: (...) & (...) & (...) & (...);
                        id?: (...) | (...);
                        pending?: (...) | (...) | (...);
                        resolved_by?: (...) | (...);
                        resolved_on?: (...) | (...);
                        state: (...) | (...);
                        updated_on: string;
                    } & {
                        links?: (...) | (...);
                    } & {
                        comment?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of pull request tasks for the given pull request.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      content: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                      created_on: string;
                      creator: (...) & (...) & (...) & (...);
                      id?: (...) | (...);
                      pending?: (...) | (...) | (...);
                      resolved_by?: (...) | (...);
                      resolved_on?: (...) | (...);
                      state: (...) | (...);
                      updated_on: string;
                  } & {
                      links?: (...) | (...);
                  } & {
                      comment?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    content: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                    created_on: string;
                    creator: (...) & (...) & (...) & (...);
                    id?: (...) | (...);
                    pending?: (...) | (...) | (...);
                    resolved_by?: (...) | (...);
                    resolved_on?: (...) | (...);
                    state: (...) | (...);
                    updated_on: string;
                } & {
                    links?: (...) | (...);
                } & {
                    comment?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  content: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
                  created_on: string;
                  creator: (...) & (...) & (...) & (...);
                  id?: (...) | (...);
                  pending?: (...) | (...) | (...);
                  resolved_by?: (...) | (...);
                  resolved_on?: (...) | (...);
                  state: (...) | (...);
                  updated_on: string;
              } & {
                  links?: (...) | (...);
              } & {
                  comment?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the user provides an invalid filter, sort, or fields query parameter.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the pull request does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    comment?: {
                        type: "comment";
                    } & Omit<Readonly<Record<(...), (...)>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        content?: {
                            html?: (...) | (...);
                            markup?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            raw?: (...) | (...);
                        };
                        created_on?: string;
                        deleted?: boolean;
                        id?: number;
                        inline?: {
                            from?: (...) | (...);
                            path: string;
                            to?: (...) | (...);
                        };
                        links?: {
                            code?: (...) | (...);
                            html?: (...) | (...);
                            self?: (...) | (...);
                        };
                        parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        updated_on?: string;
                        user?: {
                            type: ...;
                        } & Omit<(...), (...)> & Readonly<(...)> & {
                            created_on?: ...;
                            display_name?: ...;
                            links?: ...;
                            uuid?: ...;
                        };
                    };
                    content: {
                        raw: string;
                    };
                    pending?: boolean;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a task on a pull request

    Creates a new pull request task.

    Returns the newly created pull request task.
    
    Tasks can optionally be created in relation to a comment specified by the comment's ID which
    will cause the task to appear below the comment on a pull request when viewed in Bitbucket.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  comment?: {
                      type: "comment";
                  } & Omit<Readonly<Record<(...), (...)>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      content?: {
                          html?: (...) | (...);
                          markup?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          raw?: (...) | (...);
                      };
                      created_on?: string;
                      deleted?: boolean;
                      id?: number;
                      inline?: {
                          from?: (...) | (...);
                          path: string;
                          to?: (...) | (...);
                      };
                      links?: {
                          code?: (...) | (...);
                          html?: (...) | (...);
                          self?: (...) | (...);
                      };
                      parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      updated_on?: string;
                      user?: {
                          type: ...;
                      } & Omit<(...), (...)> & Readonly<(...)> & {
                          created_on?: ...;
                          display_name?: ...;
                          links?: ...;
                          uuid?: ...;
                      };
                  };
                  content: {
                      raw: string;
                  };
                  pending?: boolean;
              };
          };
      }

      The contents of the task

      • Readonlycontent: {
            application/json: {
                comment?: {
                    type: "comment";
                } & Omit<Readonly<Record<(...), (...)>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    content?: {
                        html?: (...) | (...);
                        markup?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        raw?: (...) | (...);
                    };
                    created_on?: string;
                    deleted?: boolean;
                    id?: number;
                    inline?: {
                        from?: (...) | (...);
                        path: string;
                        to?: (...) | (...);
                    };
                    links?: {
                        code?: (...) | (...);
                        html?: (...) | (...);
                        self?: (...) | (...);
                    };
                    parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    updated_on?: string;
                    user?: {
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    };
                };
                content: {
                    raw: string;
                };
                pending?: boolean;
            };
        }
        • Readonlyapplication/json: {
              comment?: {
                  type: "comment";
              } & Omit<Readonly<Record<(...), (...)>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  content?: {
                      html?: (...) | (...);
                      markup?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      raw?: (...) | (...);
                  };
                  created_on?: string;
                  deleted?: boolean;
                  id?: number;
                  inline?: {
                      from?: (...) | (...);
                      path: string;
                      to?: (...) | (...);
                  };
                  links?: {
                      code?: (...) | (...);
                      html?: (...) | (...);
                      self?: (...) | (...);
                  };
                  parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                  updated_on?: string;
                  user?: {
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  };
              };
              content: {
                  raw: string;
              };
              pending?: boolean;
          }
          • Optional Readonlycomment?: {
                type: "comment";
            } & Omit<Readonly<Record<(...), (...)>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                content?: {
                    html?: (...) | (...);
                    markup?:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    raw?: (...) | (...);
                };
                created_on?: string;
                deleted?: boolean;
                id?: number;
                inline?: {
                    from?: (...) | (...);
                    path: string;
                    to?: (...) | (...);
                };
                links?: {
                    code?: (...) | (...);
                    html?: (...) | (...);
                    self?: (...) | (...);
                };
                parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                updated_on?: string;
                user?: {
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                };
            }
          • Readonlycontent: {
                raw: string;
            }

            Task Raw Content

            task raw content

            • Readonlyraw: string

              The task contents

          • Optional Readonlypending?: boolean
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      content: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on: string;
                      creator: {
                          type: "account";
                      } & Omit<Readonly<(...)> & {
                          type: ...;
                      }, "type"> & Readonly<Record<string, unknown>> & {
                          created_on?: string;
                          display_name?: string;
                          links?: (...) & (...);
                          uuid?: string;
                      };
                      id?: number;
                      pending?: boolean;
                      resolved_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      resolved_on?: string;
                      state: "RESOLVED" | "UNRESOLVED";
                      updated_on: string;
                  } & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                  } & {
                      comment?: {
                          type: "comment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          deleted?: (...) | (...) | (...);
                          id?: (...) | (...);
                          inline?: (...) | (...);
                          links?: (...) | (...);
                          parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          updated_on?: (...) | (...);
                          user?: (...) | (...);
                      };
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    content: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on: string;
                    creator: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    pending?: boolean;
                    resolved_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    resolved_on?: string;
                    state: "RESOLVED" | "UNRESOLVED";
                    updated_on: string;
                } & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                } & {
                    comment?: {
                        type: "comment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        deleted?: (...) | (...) | (...);
                        id?: (...) | (...);
                        inline?: (...) | (...);
                        links?: (...) | (...);
                        parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        updated_on?: (...) | (...);
                        user?: (...) | (...);
                    };
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created task.

        • content: {
              application/json: {
                  content: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on: string;
                  creator: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  id?: number;
                  pending?: boolean;
                  resolved_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  resolved_on?: string;
                  state: "RESOLVED" | "UNRESOLVED";
                  updated_on: string;
              } & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
              } & {
                  comment?: {
                      type: "comment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      deleted?: (...) | (...) | (...);
                      id?: (...) | (...);
                      inline?: (...) | (...);
                      links?: (...) | (...);
                      parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      updated_on?: (...) | (...);
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                content: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on: string;
                creator: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                id?: number;
                pending?: boolean;
                resolved_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                resolved_on?: string;
                state: "RESOLVED" | "UNRESOLVED";
                updated_on: string;
            } & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
            } & {
                comment?: {
                    type: "comment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    deleted?: (...) | (...) | (...);
                    id?: (...) | (...);
                    inline?: (...) | (...);
                    links?: (...) | (...);
                    parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    updated_on?: (...) | (...);
                    user?: (...) | (...);
                };
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the new task

      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        There is a missing required field in the request or the task content is blank.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the pull request does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            task_id: number;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    content?: {
                        raw: string;
                    };
                    state?: "RESOLVED" | "UNRESOLVED";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a task on a pull request

    Deletes a specific pull request task.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              task_id: number;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            task_id: number;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytask_id: number

          The ID of the task.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful deletion.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to delete the task.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the task does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a task on a pull request

    Returns a specific pull request task.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              task_id: number;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            task_id: number;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytask_id: number

          The ID of the task.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      content: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on: string;
                      creator: {
                          type: "account";
                      } & Omit<Readonly<(...)> & {
                          type: ...;
                      }, "type"> & Readonly<Record<string, unknown>> & {
                          created_on?: string;
                          display_name?: string;
                          links?: (...) & (...);
                          uuid?: string;
                      };
                      id?: number;
                      pending?: boolean;
                      resolved_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      resolved_on?: string;
                      state: "RESOLVED" | "UNRESOLVED";
                      updated_on: string;
                  } & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                  } & {
                      comment?: {
                          type: "comment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          deleted?: (...) | (...) | (...);
                          id?: (...) | (...);
                          inline?: (...) | (...);
                          links?: (...) | (...);
                          parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          updated_on?: (...) | (...);
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    content: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on: string;
                    creator: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    pending?: boolean;
                    resolved_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    resolved_on?: string;
                    state: "RESOLVED" | "UNRESOLVED";
                    updated_on: string;
                } & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                } & {
                    comment?: {
                        type: "comment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        deleted?: (...) | (...) | (...);
                        id?: (...) | (...);
                        inline?: (...) | (...);
                        links?: (...) | (...);
                        parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        updated_on?: (...) | (...);
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The task.

        • content: {
              application/json: {
                  content: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on: string;
                  creator: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  id?: number;
                  pending?: boolean;
                  resolved_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  resolved_on?: string;
                  state: "RESOLVED" | "UNRESOLVED";
                  updated_on: string;
              } & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
              } & {
                  comment?: {
                      type: "comment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      deleted?: (...) | (...) | (...);
                      id?: (...) | (...);
                      inline?: (...) | (...);
                      links?: (...) | (...);
                      parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      updated_on?: (...) | (...);
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                content: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on: string;
                creator: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                id?: number;
                pending?: boolean;
                resolved_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                resolved_on?: string;
                state: "RESOLVED" | "UNRESOLVED";
                updated_on: string;
            } & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
            } & {
                comment?: {
                    type: "comment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    deleted?: (...) | (...) | (...);
                    id?: (...) | (...);
                    inline?: (...) | (...);
                    links?: (...) | (...);
                    parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    updated_on?: (...) | (...);
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the task does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            pull_request_id: number;
            repo_slug: string;
            task_id: number;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          pull_request_id: number;
          repo_slug: string;
          task_id: number;
          workspace: string;
      }
      • Readonlypull_request_id: number

        The id of the pull request.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlytask_id: number

        The ID of the task.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                pull_request_id: number;
                repo_slug: string;
                task_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    content?: {
                        raw: string;
                    };
                    state?: "RESOLVED" | "UNRESOLVED";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        content: {
                            html?: string;
                            markup?: "creole" | "markdown" | "plaintext";
                            raw?: string;
                        };
                        created_on: string;
                        creator: {
                            type: "account";
                        } & Omit<Readonly<(...)> & {
                            type: ...;
                        }, "type"> & Readonly<Record<string, unknown>> & {
                            created_on?: string;
                            display_name?: string;
                            links?: (...) & (...);
                            uuid?: string;
                        };
                        id?: number;
                        pending?: boolean;
                        resolved_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        resolved_on?: string;
                        state: "RESOLVED" | "UNRESOLVED";
                        updated_on: string;
                    } & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                    } & {
                        comment?: {
                            type: "comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            content?: (...) | (...);
                            created_on?: (...) | (...);
                            deleted?: (...) | (...) | (...);
                            id?: (...) | (...);
                            inline?: (...) | (...);
                            links?: (...) | (...);
                            parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                            updated_on?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a task on a pull request

    Updates a specific pull request task.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              pull_request_id: number;
              repo_slug: string;
              task_id: number;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            pull_request_id: number;
            repo_slug: string;
            task_id: number;
            workspace: string;
        }
        • Readonlypull_request_id: number

          The id of the pull request.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlytask_id: number

          The ID of the task.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  content?: {
                      raw: string;
                  };
                  state?: "RESOLVED" | "UNRESOLVED";
              };
          };
      }

      The updated state and content of the task.

      • Readonlycontent: {
            application/json: {
                content?: {
                    raw: string;
                };
                state?: "RESOLVED" | "UNRESOLVED";
            };
        }
        • Readonlyapplication/json: {
              content?: {
                  raw: string;
              };
              state?: "RESOLVED" | "UNRESOLVED";
          }
          • Optional Readonlycontent?: {
                raw: string;
            }

            Task Raw Content

            task raw content

            • Readonlyraw: string

              The task contents

          • Optional Readonlystate?: "RESOLVED" | "UNRESOLVED"
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      content: {
                          html?: string;
                          markup?: "creole" | "markdown" | "plaintext";
                          raw?: string;
                      };
                      created_on: string;
                      creator: {
                          type: "account";
                      } & Omit<Readonly<(...)> & {
                          type: ...;
                      }, "type"> & Readonly<Record<string, unknown>> & {
                          created_on?: string;
                          display_name?: string;
                          links?: (...) & (...);
                          uuid?: string;
                      };
                      id?: number;
                      pending?: boolean;
                      resolved_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      resolved_on?: string;
                      state: "RESOLVED" | "UNRESOLVED";
                      updated_on: string;
                  } & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                  } & {
                      comment?: {
                          type: "comment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          content?: (...) | (...);
                          created_on?: (...) | (...);
                          deleted?: (...) | (...) | (...);
                          id?: (...) | (...);
                          inline?: (...) | (...);
                          links?: (...) | (...);
                          parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                          updated_on?: (...) | (...);
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    content: {
                        html?: string;
                        markup?: "creole" | "markdown" | "plaintext";
                        raw?: string;
                    };
                    created_on: string;
                    creator: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    pending?: boolean;
                    resolved_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    resolved_on?: string;
                    state: "RESOLVED" | "UNRESOLVED";
                    updated_on: string;
                } & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                } & {
                    comment?: {
                        type: "comment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        content?: (...) | (...);
                        created_on?: (...) | (...);
                        deleted?: (...) | (...) | (...);
                        id?: (...) | (...);
                        inline?: (...) | (...);
                        links?: (...) | (...);
                        parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                        updated_on?: (...) | (...);
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated task.

        • content: {
              application/json: {
                  content: {
                      html?: string;
                      markup?: "creole" | "markdown" | "plaintext";
                      raw?: string;
                  };
                  created_on: string;
                  creator: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  id?: number;
                  pending?: boolean;
                  resolved_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  resolved_on?: string;
                  state: "RESOLVED" | "UNRESOLVED";
                  updated_on: string;
              } & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
              } & {
                  comment?: {
                      type: "comment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      content?: (...) | (...);
                      created_on?: (...) | (...);
                      deleted?: (...) | (...) | (...);
                      id?: (...) | (...);
                      inline?: (...) | (...);
                      links?: (...) | (...);
                      parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                      updated_on?: (...) | (...);
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                content: {
                    html?: string;
                    markup?: "creole" | "markdown" | "plaintext";
                    raw?: string;
                };
                created_on: string;
                creator: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                id?: number;
                pending?: boolean;
                resolved_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                resolved_on?: string;
                state: "RESOLVED" | "UNRESOLVED";
                updated_on: string;
            } & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
            } & {
                comment?: {
                    type: "comment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    content?: (...) | (...);
                    created_on?: (...) | (...);
                    deleted?: (...) | (...) | (...);
                    id?: (...) | (...);
                    inline?: (...) | (...);
                    links?: (...) | (...);
                    parent?: ({ readonly type: "comment"; } & Omit<Readonly<Record<string, unknown>> & { readonly type: string; }, "type"> & Readonly<Record<string, unknown>> & { ...; }) | undefined;
                    updated_on?: (...) | (...);
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        There is a missing required field in the request or the task content is blank.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the pull request.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the task does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a pull request application property

    Delete an application property value stored against a pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              pullrequest_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            pullrequest_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlypullrequest_id: string

          The pull request ID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a pull request application property

    Retrieve an application property value stored against a pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              pullrequest_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            pullrequest_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlypullrequest_id: string

          The pull request ID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      _attributes?: readonly ("public" | "read_only")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The value of the property.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                pullrequest_id: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a pull request application property

    Update an application property value stored against a pull request.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              pullrequest_id: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            pullrequest_id: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlypullrequest_id: string

          The pull request ID.

        • Readonlyrepo_slug: string

          The repository.

        • Readonlyworkspace: string

          The repository container; either the workspace slug or the UUID in curly braces.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              _attributes?: readonly ("public" | "read_only")[];
          }
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/pullrequests/activity: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List a pull request activity log

    Returns a paginated list of the pull request's activity log.

    This handler serves both a v20 and internal endpoint. The v20 endpoint
    returns reviewer comments, updates, approvals and request changes. The internal
    endpoint includes those plus tasks and attachments.
    
    Comments created on a file or a line of code have an inline property.
    
    Comment example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "comment": {
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088"
                        }
                    },
                    "deleted": false,
                    "pullrequest": {
                        "type": "pullrequest",
                        "id": 5695,
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                            },
                            "html": {
                                "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                            }
                        },
                        "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                    },
                    "content": {
                        "raw": "inline with to a dn from lines",
                        "markup": "markdown",
                        "html": "<p>inline with to a dn from lines</p>",
                        "type": "rendered"
                    },
                    "created_on": "2019-09-27T00:33:46.039178+00:00",
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "created_on": "2019-09-27T00:33:46.039178+00:00",
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "updated_on": "2019-09-27T00:33:46.055384+00:00",
                    "inline": {
                        "context_lines": "",
                        "to": null,
                        "path": "",
                        "outdated": false,
                        "from": 211
                    },
                    "type": "pullrequest_comment",
                    "id": 118571088
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    Updates include a state property of OPEN, MERGED, or DECLINED.
    
    Update example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "update": {
                    "description": "",
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it",
                    "destination": {
                        "commit": {
                            "type": "commit",
                            "hash": "6a2c16e4a152",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152"
                                }
                            }
                        },
                        "branch": {
                            "name": "master"
                        },
                        "repository": {
                            "name": "Atlaskit-MK-2",
                            "type": "repository",
                            "full_name": "atlassian/atlaskit-mk-2",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2"
                                },
                                "avatar": {
                                    "href": "https://bytebucket.org/ravatar/%7B%7D?ts=js"
                                }
                            },
                            "uuid": "{}"
                        }
                    },
                    "reason": "",
                    "source": {
                        "commit": {
                            "type": "commit",
                            "hash": "728c8bad1813",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813"
                                }
                            }
                        },
                        "branch": {
                            "name": "username/NONE-add-onClick-prop-for-accessibility"
                        },
                        "repository": {
                            "name": "Atlaskit-MK-2",
                            "type": "repository",
                            "full_name": "atlassian/atlaskit-mk-2",
                            "links": {
                                "self": {
                                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2"
                                },
                                "html": {
                                    "href": "https://bitbucket.org/atlassian/atlaskit-mk-2"
                                },
                                "avatar": {
                                    "href": "https://bytebucket.org/ravatar/%7B%7D?ts=js"
                                }
                            },
                            "uuid": "{}"
                        }
                    },
                    "state": "OPEN",
                    "author": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    },
                    "date": "2019-05-10T06:48:25.305565+00:00"
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    Approval example:
    ```
    {
        "pagelen": 20,
        "values": [
            {
                "approval": {
                    "date": "2019-09-27T00:37:19.849534+00:00",
                    "pullrequest": {
                        "type": "pullrequest",
                        "id": 5695,
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                            },
                            "html": {
                                "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                            }
                        },
                        "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                    },
                    "user": {
                        "display_name": "Name Lastname",
                        "uuid": "{}",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/%7B%7D"
                            },
                            "html": {
                                "href": "https://bitbucket.org/%7B%7D/"
                            },
                            "avatar": {
                                "href": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128"
                            }
                        },
                        "type": "user",
                        "nickname": "Name",
                        "account_id": ""
                    }
                },
                "pull_request": {
                    "type": "pullrequest",
                    "id": 5695,
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695"
                        },
                        "html": {
                            "href": "https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695"
                        }
                    },
                    "title": "username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it"
                }
            }
        ]
    }
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The pull request activity log

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the request was not authenticated.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/refs: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List branches and tags

    Returns the branches and tags in the repository.

    By default, results will be in the order the underlying source control system returns them and identical to
    the ordering one sees when running "$ git show-ref". Note that this follows simple
    lexical ordering of the ref names.
    
    This can be undesirable as it does apply any natural sorting semantics, meaning for instance that refs are
    sorted ["branch1", "branch10", "branch2", "v10", "v11", "v9"] instead of ["branch1", "branch2",
    "branch10", "v9", "v10", "v11"].
    
    Sorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,
    Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. The name field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of refs matching any filter criteria that were provided.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/refs/branches: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        default_merge_strategy?: string;
                        merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            default_merge_strategy?: (...) | (...);
                            merge_strategies?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List open branches

    Returns a list of all open branches within the specified repository. Results will be in the order the source control manager returns them.

    Branches support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)
    that can be used to search for specific branches. For instance, to find
    all branches that have "stab" in their name:
    
    ```
    curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches -G --data-urlencode 'q=name ~ "stab"'
    ```
    
    By default, results will be in the order the underlying source control system returns them and identical to
    the ordering one sees when running "$ git branch --list". Note that this follows simple
    lexical ordering of the ref names.
    
    This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are
    sorted ["v10", "v11", "v9"] instead of ["v9", "v10", "v11"].
    
    Sorting can be changed using the ?q= query parameter. When using ?q=name to explicitly sort on ref name,
    Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. The name field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['branch1', 'branch2', 'branch10'] instead of ['branch1', 'branch10', 'branch2'].

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          default_merge_strategy?: (...) | (...);
                          merge_strategies?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        default_merge_strategy?: (...) | (...);
                        merge_strategies?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of branches matching any filter criteria that were provided.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      default_merge_strategy?: (...) | (...);
                      merge_strategies?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    default_merge_strategy?: (...) | (...);
                    merge_strategies?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              } & {
                  default_merge_strategy?: (...) | (...);
                  merge_strategies?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        default_merge_strategy?: string;
                        merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a branch

    Creates a new branch in the specified repository.

    The payload of the POST should consist of a JSON document that
    contains the name of the tag and the target hash.
    
    ```
    curl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \
    -s -u seanfarley -X POST -H "Content-Type: application/json" \
    -d '{
        "name" : "smf/create-feature",
        "target" : {
            "hash" : "default",
        }
    }'
    ```
    
    This call requires authentication. Private repositories require the
    caller to authenticate with an account that has appropriate
    authorization.
    
    The branch name should not include any prefixes (e.g.
    refs/heads). This endpoint does support using short hash prefixes for
    the commit hash, but it may return a 400 response if the provided
    prefix is ambiguous. Using a full commit hash is the preferred
    approach.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      target?: {
                          type: "commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          participants?: (...) | (...);
                          repository?: (...) | (...);
                      };
                      type: string;
                  } & {
                      default_merge_strategy?: string;
                      merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        participants?: (...) | (...);
                        repository?: (...) | (...);
                    };
                    type: string;
                } & {
                    default_merge_strategy?: string;
                    merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly created branch object.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  target?: {
                      type: "commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      participants?: (...) | (...);
                      repository?: (...) | (...);
                  };
                  type: string;
              } & {
                  default_merge_strategy?: string;
                  merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                target?: {
                    type: "commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    participants?: (...) | (...);
                    repository?: (...) | (...);
                };
                type: string;
            } & {
                default_merge_strategy?: string;
                merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or branch does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/refs/branches/{name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        default_merge_strategy?: string;
                        merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            name: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a branch

    Delete a branch in the specified repository.

    The main branch is not allowed to be deleted and will return a 400
    response.
    
    The branch name should not include any prefixes (e.g.
    refs/heads).
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyname: string

          The name of the branch.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates that the specified branch was successfully deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or branch does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        default_merge_strategy?: string;
                        merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a branch

    Returns a branch object within the specified repository.

    This call requires authentication. Private repositories require the
    caller to authenticate with an account that has appropriate
    authorization.
    
    For Git, the branch name should not include any prefixes (e.g.
    refs/heads).
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyname: string

          The name of the branch.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      target?: {
                          type: "commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          participants?: (...) | (...);
                          repository?: (...) | (...);
                      };
                      type: string;
                  } & {
                      default_merge_strategy?: string;
                      merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        participants?: (...) | (...);
                        repository?: (...) | (...);
                    };
                    type: string;
                } & {
                    default_merge_strategy?: string;
                    merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branch object.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  target?: {
                      type: "commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      participants?: (...) | (...);
                      repository?: (...) | (...);
                  };
                  type: string;
              } & {
                  default_merge_strategy?: string;
                  merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                target?: {
                    type: "commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    participants?: (...) | (...);
                    repository?: (...) | (...);
                };
                type: string;
            } & {
                default_merge_strategy?: string;
                merge_strategies?: readonly ("fast_forward" | "merge_commit" | "squash")[];
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or branch does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            name: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          name: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyname: string

        The name of the branch.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/refs/tags: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            date?: (...) | (...);
                            message?: (...) | (...);
                            tagger?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                    type: string;
                } & {
                    date?: string;
                    message?: string;
                    tagger?: {
                        type: "author";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        raw?: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        date?: string;
                        message?: string;
                        tagger?: {
                            type: "author";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            raw?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            name?: (...) | (...);
                            target?: (...) | (...);
                            type: string;
                        } & {
                            date?: (...) | (...);
                            message?: (...) | (...);
                            tagger?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List tags

    Returns the tags in the repository.

    By default, results will be in the order the underlying source control system returns them and identical to
    the ordering one sees when running "$ git tag --list". Note that this follows simple
    lexical ordering of the ref names.
    
    This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are
    sorted ["v10", "v11", "v9"] instead of ["v9", "v10", "v11"].
    
    Sorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,
    Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Field by which the results should be sorted as per filtering and sorting. The name field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          name?: (...) | (...);
                          target?: (...) | (...);
                          type: string;
                      } & {
                          date?: (...) | (...);
                          message?: (...) | (...);
                          tagger?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        name?: (...) | (...);
                        target?: (...) | (...);
                        type: string;
                    } & {
                        date?: (...) | (...);
                        message?: (...) | (...);
                        tagger?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of tags matching any filter criteria that were provided.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      name?: (...) | (...);
                      target?: (...) | (...);
                      type: string;
                  } & {
                      date?: (...) | (...);
                      message?: (...) | (...);
                      tagger?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    name?: (...) | (...);
                    target?: (...) | (...);
                    type: string;
                } & {
                    date?: (...) | (...);
                    message?: (...) | (...);
                    tagger?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  name?: (...) | (...);
                  target?: (...) | (...);
                  type: string;
              } & {
                  date?: (...) | (...);
                  message?: (...) | (...);
                  tagger?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        author?: ...;
                        date?: ...;
                        hash?: ...;
                        message?: ...;
                        parents?: ...;
                        summary?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        participants?: readonly (...)[];
                        repository?: (...) & (...) & (...) & (...);
                    };
                    type: string;
                } & {
                    date?: string;
                    message?: string;
                    tagger?: {
                        type: "author";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        raw?: string;
                        user?: (...) & (...) & (...) & (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        date?: string;
                        message?: string;
                        tagger?: {
                            type: "author";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            raw?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a tag

    Creates a new tag in the specified repository.

    The payload of the POST should consist of a JSON document that
    contains the name of the tag and the target hash.
    
    ```
    curl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \
    -s -u jdoe -X POST -H "Content-Type: application/json" \
    -d '{
        "name" : "new-tag-name",
        "target" : {
            "hash" : "a1b2c3d4e5f6",
        }
    }'
    ```
    
    This endpoint does support using short hash prefixes for the commit
    hash, but it may return a 400 response if the provided prefix is
    ambiguous. Using a full commit hash is the preferred approach.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      commits?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  name?: string;
                  target?: {
                      type: "commit";
                  } & Omit<{
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      author?: ...;
                      date?: ...;
                      hash?: ...;
                      message?: ...;
                      parents?: ...;
                      summary?: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      participants?: readonly (...)[];
                      repository?: (...) & (...) & (...) & (...);
                  };
                  type: string;
              } & {
                  date?: string;
                  message?: string;
                  tagger?: {
                      type: "author";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      raw?: string;
                      user?: (...) & (...) & (...) & (...);
                  };
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                links?: {
                    commits?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                name?: string;
                target?: {
                    type: "commit";
                } & Omit<{
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    author?: ...;
                    date?: ...;
                    hash?: ...;
                    message?: ...;
                    parents?: ...;
                    summary?: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    participants?: readonly (...)[];
                    repository?: (...) & (...) & (...) & (...);
                };
                type: string;
            } & {
                date?: string;
                message?: string;
                tagger?: {
                    type: "author";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    raw?: string;
                    user?: (...) & (...) & (...) & (...);
                };
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              links?: {
                  commits?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              name?: string;
              target?: {
                  type: "commit";
              } & Omit<{
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  author?: ...;
                  date?: ...;
                  hash?: ...;
                  message?: ...;
                  parents?: ...;
                  summary?: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  participants?: readonly (...)[];
                  repository?: (...) & (...) & (...) & (...);
              };
              type: string;
          } & {
              date?: string;
              message?: string;
              tagger?: {
                  type: "author";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  raw?: string;
                  user?: (...) & (...) & (...) & (...);
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      target?: {
                          type: "commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          participants?: (...) | (...);
                          repository?: (...) | (...);
                      };
                      type: string;
                  } & {
                      date?: string;
                      message?: string;
                      tagger?: {
                          type: "author";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          raw?: (...) | (...);
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        participants?: (...) | (...);
                        repository?: (...) | (...);
                    };
                    type: string;
                } & {
                    date?: string;
                    message?: string;
                    tagger?: {
                        type: "author";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        raw?: (...) | (...);
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly created tag.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  target?: {
                      type: "commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      participants?: (...) | (...);
                      repository?: (...) | (...);
                  };
                  type: string;
              } & {
                  date?: string;
                  message?: string;
                  tagger?: {
                      type: "author";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      raw?: (...) | (...);
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                target?: {
                    type: "commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    participants?: (...) | (...);
                    repository?: (...) | (...);
                };
                type: string;
            } & {
                date?: string;
                message?: string;
                tagger?: {
                    type: "author";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    raw?: (...) | (...);
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the target hash is missing, ambiguous, or invalid, or if the name is not provided.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/refs/tags/{name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        date?: string;
                        message?: string;
                        tagger?: {
                            type: "author";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            raw?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            name: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a tag

    Delete a tag in the specified repository.

    The tag name should not include any prefixes (e.g. refs/tags).
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyname: string

          The name of the tag.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates the specified tag was successfully deleted.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or tag does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            commits?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        target?: {
                            type: "commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            participants?: (...) | (...);
                            repository?: (...) | (...);
                        };
                        type: string;
                    } & {
                        date?: string;
                        message?: string;
                        tagger?: {
                            type: "author";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            raw?: (...) | (...);
                            user?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a tag

    Returns the specified tag.

    ```
    $ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8 -G | jq .
    {
      "name": "3.8",
      "links": {
        "commits": {
          "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commits/3.8"
        },
        "self": {
          "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8"
        },
        "html": {
          "href": "https://bitbucket.org/seanfarley/hg/commits/tag/3.8"
        }
      },
      "tagger": {
        "raw": "Matt Mackall <mpm@selenic.com>",
        "type": "author",
        "user": {
          "username": "mpmselenic",
          "nickname": "mpmselenic",
          "display_name": "Matt Mackall",
          "type": "user",
          "uuid": "{a4934530-db4c-419c-a478-9ab4964c2ee7}",
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/users/mpmselenic"
            },
            "html": {
              "href": "https://bitbucket.org/mpmselenic/"
            },
            "avatar": {
              "href": "https://bitbucket.org/account/mpmselenic/avatar/32/"
            }
          }
        }
      },
      "date": "2016-05-01T18:52:25+00:00",
      "message": "Added tag 3.8 for changeset f85de28eae32",
      "type": "tag",
      "target": {
        "hash": "f85de28eae32e7d3064b1a1321309071bbaaa069",
        "repository": {
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg"
            },
            "html": {
              "href": "https://bitbucket.org/seanfarley/hg"
            },
            "avatar": {
              "href": "https://bitbucket.org/seanfarley/hg/avatar/32/"
            }
          },
          "type": "repository",
          "name": "hg",
          "full_name": "seanfarley/hg",
          "uuid": "{c75687fb-e99d-4579-9087-190dbd406d30}"
        },
        "links": {
          "self": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069"
          },
          "comments": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/comments"
          },
          "patch": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/patch/f85de28eae32e7d3064b1a1321309071bbaaa069"
          },
          "html": {
            "href": "https://bitbucket.org/seanfarley/hg/commits/f85de28eae32e7d3064b1a1321309071bbaaa069"
          },
          "diff": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/diff/f85de28eae32e7d3064b1a1321309071bbaaa069"
          },
          "approve": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/approve"
          },
          "statuses": {
            "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/statuses"
          }
        },
        "author": {
          "raw": "Sean Farley <sean@farley.io>",
          "type": "author",
          "user": {
            "username": "seanfarley",
            "nickname": "seanfarley",
            "display_name": "Sean Farley",
            "type": "user",
            "uuid": "{a295f8a8-5876-4d43-89b5-3ad8c6c3c51d}",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/users/seanfarley"
              },
              "html": {
                "href": "https://bitbucket.org/seanfarley/"
              },
              "avatar": {
                "href": "https://bitbucket.org/account/seanfarley/avatar/32/"
              }
            }
          }
        },
        "parents": [
          {
            "hash": "9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2",
            "type": "commit",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2"
              },
              "html": {
                "href": "https://bitbucket.org/seanfarley/hg/commits/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2"
              }
            }
          }
        ],
        "date": "2016-05-01T04:21:17+00:00",
        "message": "debian: alphabetize build deps",
        "type": "commit"
      }
    }
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              name: string;
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            name: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlyname: string

          The name of the tag.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          commits?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      target?: {
                          type: "commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          participants?: (...) | (...);
                          repository?: (...) | (...);
                      };
                      type: string;
                  } & {
                      date?: string;
                      message?: string;
                      tagger?: {
                          type: "author";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          raw?: (...) | (...);
                          user?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        commits?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    target?: {
                        type: "commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        participants?: (...) | (...);
                        repository?: (...) | (...);
                    };
                    type: string;
                } & {
                    date?: string;
                    message?: string;
                    tagger?: {
                        type: "author";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        raw?: (...) | (...);
                        user?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The tag object.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      commits?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  target?: {
                      type: "commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      participants?: (...) | (...);
                      repository?: (...) | (...);
                  };
                  type: string;
              } & {
                  date?: string;
                  message?: string;
                  tagger?: {
                      type: "author";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      raw?: (...) | (...);
                      user?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    commits?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                target?: {
                    type: "commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    participants?: (...) | (...);
                    repository?: (...) | (...);
                };
                type: string;
            } & {
                date?: string;
                message?: string;
                tagger?: {
                    type: "author";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    raw?: (...) | (...);
                    user?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository is private and the authenticated user does not have access to it.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or tag does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            name: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          name: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlyname: string

        The name of the tag.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/src: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                format?: "meta";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                author?: string;
                branch?: string;
                files?: string;
                message?: string;
                parents?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                format?: "meta";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the root directory of the main branch

    This endpoint redirects the client to the directory listing of the root directory on the main branch.

    This is equivalent to directly hitting
    [/2.0/repositories/{username}/{repo_slug}/src/{commit}/{path}](src/%7Bcommit%7D/%7Bpath%7D)
    without having to know the name or SHA1 of the repo's main branch.
    
    To create new commits, [POST to this endpoint](#post)
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              format?: "meta";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            format?: "meta";
        }
        • Optional Readonlyformat?: "meta"

          Instead of returning the file's contents, return the (json) meta data for it.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          path?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        path?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the path matches a file, then the raw contents of the file are returned (unless the format=meta query parameter was provided, in which case a json document containing the file's meta data is returned). If the path matches a directory, then a paginated list of file and directory entries is returned (if the format=meta query parameter was provided, then the json document containing the directory's meta data is returned).

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      path?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    path?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  commit?: (...) | (...);
                  path?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the path or commit in the URL does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                author?: string;
                branch?: string;
                files?: string;
                message?: string;
                parents?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            201: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a commit by uploading a file

    This endpoint is used to create new commits in the repository by uploading files.

    To add a new file to a repository:
    
    ```
    $ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \
      -F /repo/path/to/image.png=@image.png
    ```
    
    This will create a new commit on top of the main branch, inheriting the
    contents of the main branch, but adding (or overwriting) the
    `image.png` file to the repository in the `/repo/path/to` directory.
    
    To create a commit that deletes files, use the `files` parameter:
    
    ```
    $ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \
      -F files=/file/to/delete/1.txt \
      -F files=/file/to/delete/2.txt
    ```
    
    You can add/modify/delete multiple files in a request. Rename/move a
    file by deleting the old path and adding the content at the new path.
    
    This endpoint accepts `multipart/form-data` (as in the examples above),
    as well as `application/x-www-form-urlencoded`.
    
    Note: `multipart/form-data` is currently not supported by Forge apps
    for this API.
    
    #### multipart/form-data
    
    A `multipart/form-data` post contains a series of "form fields" that
    identify both the individual files that are being uploaded, as well as
    additional, optional meta data.
    
    Files are uploaded in file form fields (those that have a
    `Content-Disposition` parameter) whose field names point to the remote
    path in the repository where the file should be stored. Path field
    names are always interpreted to be absolute from the root of the
    repository, regardless whether the client uses a leading slash (as the
    above `curl` example did).
    
    File contents are treated as bytes and are not decoded as text.
    
    The commit message, as well as other non-file meta data for the
    request, is sent along as normal form field elements. Meta data fields
    share the same namespace as the file objects. For `multipart/form-data`
    bodies that should not lead to any ambiguity, as the
    `Content-Disposition` header will contain the `filename` parameter to
    distinguish between a file named "message" and the commit message field.
    
    #### application/x-www-form-urlencoded
    
    It is also possible to upload new files using a simple
    `application/x-www-form-urlencoded` POST. This can be convenient when
    uploading pure text files:
    
    ```
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src \
      --data-urlencode "/path/to/me.txt=Lorem ipsum." \
      --data-urlencode "message=Initial commit" \
      --data-urlencode "author=Erik van Zijst <erik.van.zijst@gmail.com>"
    ```
    
    There could be a field name clash if a client were to upload a file
    named "message", as this filename clashes with the meta data property
    for the commit message. To avoid this and to upload files whose names
    clash with the meta data properties, use a leading slash for the files,
    e.g. `curl --data-urlencode "/message=file contents"`.
    
    When an explicit slash is omitted for a file whose path matches that of
    a meta data parameter, then it is interpreted as meta data, not as a
    file.
    
    #### Executables and links
    
    While this API aims to facilitate the most common use cases, it is
    possible to perform some more advanced operations like creating a new
    symlink in the repository, or creating an executable file.
    
    Files can be supplied with a `x-attributes` value in the
    `Content-Disposition` header. For example, to upload an executable
    file, as well as create a symlink from `README.txt` to `README`:
    
    ```
    --===============1438169132528273974==
    Content-Type: text/plain; charset="us-ascii"
    MIME-Version: 1.0
    Content-Transfer-Encoding: 7bit
    Content-ID: "bin/shutdown.sh"
    Content-Disposition: attachment; filename="shutdown.sh"; x-attributes:"executable"
    
    #!/bin/sh
    halt
    
    --===============1438169132528273974==
    Content-Type: text/plain; charset="us-ascii"
    MIME-Version: 1.0
    Content-Transfer-Encoding: 7bit
    Content-ID: "/README.txt"
    Content-Disposition: attachment; filename="README.txt"; x-attributes:"link"
    
    README
    --===============1438169132528273974==--
    ```
    
    Links are files that contain the target path and have
    `x-attributes:"link"` set.
    
    When overwriting links with files, or vice versa, the newly uploaded
    file determines both the new contents, as well as the attributes. That
    means uploading a file without specifying `x-attributes="link"` will
    create a regular file, even if the parent commit hosted a symlink at
    the same path.
    
    The same applies to executables. When modifying an existing executable
    file, the form-data file element must include
    `x-attributes="executable"` in order to preserve the executable status
    of the file.
    
    Note that this API does not support the creation or manipulation of
    subrepos / submodules.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              author?: string;
              branch?: string;
              files?: string;
              message?: string;
              parents?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            author?: string;
            branch?: string;
            files?: string;
            message?: string;
            parents?: string;
        }
        • Optional Readonlyauthor?: string

          The raw string to be used as the new commit's author. This string follows the format Erik van Zijst <evzijst@atlassian.com>.

          When omitted, Bitbucket uses the authenticated user's
          full/display name and primary email address. Commits cannot
          be created anonymously.
          
        • Optional Readonlybranch?: string

          The name of the branch that the new commit should be created on. When omitted, the commit will be created on top of the main branch and will become the main branch's new head.

          When a branch name is provided that already exists in the
          repo, then the commit will be created on top of that
          branch. In this case, *if* a parent SHA1 was also provided,
          then it is asserted that the parent is the branch's
          tip/HEAD at the time the request is made. When this is not
          the case, a 409 is returned.
          
          When a new branch name is specified (that does not already
          exist in the repo), and no parent SHA1s are provided, then
          the new commit will inherit from the current main branch's
          tip/HEAD commit, but not advance the main branch. The new
          commit will be the new branch. When the request *also*
          specifies a parent SHA1, then the new commit and branch
          are created directly on top of the parent commit,
          regardless of the state of the main branch.
          
          When a branch name is not specified, but a parent SHA1 is
          provided, then Bitbucket asserts that it represents the
          main branch's current HEAD/tip, or a 409 is returned.
          
          When a branch name is not specified and the repo is empty,
          the new commit will become the repo's root commit and will
          be on the main branch.
          
          When a branch name is specified and the repo is empty, the
          new commit will become the repo's root commit and also
          define the repo's main branch going forward.
          
          This API cannot be used to create additional root commits
          in non-empty repos.
          
          The branch field cannot be repeated.
          
          As a side effect, this API can be used to create a new
          branch without modifying any files, by specifying a new
          branch name in this field, together with `parents`, but
          omitting the `files` fields, while not sending any files.
          This will create a new commit and branch with the same
          contents as the first parent. The diff of this commit
          against its first parent will be empty.
          
        • Optional Readonlyfiles?: string

          Optional field that declares the files that the request is manipulating. When adding a new file to a repo, or when overwriting an existing file, the client can just upload the full contents of the file in a normal form field and the use of this files meta data field is redundant. However, when the files field contains a file path that does not have a corresponding, identically-named form field, then Bitbucket interprets that as the client wanting to replace the named file with the null set and the file is deleted instead.

          Paths in the repo that are referenced in neither files nor
          an individual file field, remain unchanged and carry over
          from the parent to the new commit.
          
          This API does not support renaming as an explicit feature.
          To rename a file, simply delete it and recreate it under
          the new name in the same commit.
          
        • Optional Readonlymessage?: string

          The commit message. When omitted, Bitbucket uses a canned string.

        • Optional Readonlyparents?: string

          A comma-separated list of SHA1s of the commits that should be the parents of the newly created commit.

          When omitted, the new commit will inherit from and become
          a child of the main branch's tip/HEAD commit.
          
          When more than one SHA1 is provided, the first SHA1
          identifies the commit from which the content will be
          inherited.".
          
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }
        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have write or admin access

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the repository does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/src/{commit}/{path}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                format?: "meta" | "rendered";
                max_depth?: number;
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commit: string;
                path: string;
                repo_slug: string;
                workspace: string;
            };
            query?: {
                format?: "meta" | "rendered";
                max_depth?: number;
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            commit?: (...) | (...);
                            path?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            555: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get file or directory contents

    This endpoints is used to retrieve the contents of a single file, or the contents of a directory at a specified revision.

    #### Raw file contents
    
    When `path` points to a file, this endpoint returns the raw contents.
    The response's Content-Type is derived from the filename
    extension (not from the contents). The file contents are not processed
    and no character encoding/recoding is performed and as a result no
    character encoding is included as part of the Content-Type.
    
    The `Content-Disposition` header will be "attachment" to prevent
    browsers from running executable files.
    
    If the file is managed by LFS, then a 301 redirect pointing to
    Atlassian's media services platform is returned.
    
    The response includes an ETag that is based on the contents of the file
    and its attributes. This means that an empty `__init__.py` always
    returns the same ETag, regardless on the directory it lives in, or the
    commit it is on.
    
    #### File meta data
    
    When the request for a file path includes the query parameter
    `?format=meta`, instead of returning the file's raw contents, Bitbucket
    instead returns the JSON object describing the file's properties:
    
    ```javascript
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests/__init__.py?format=meta
    {
      "links": {
        "self": {
          "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py"
        },
        "meta": {
          "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta"
        }
      },
      "path": "tests/__init__.py",
      "commit": {
        "type": "commit",
        "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
        "links": {
          "self": {
            "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
          },
          "html": {
            "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
          }
        }
      },
      "attributes": [],
      "type": "commit_file",
      "size": 0
    }
    ```
    
    File objects contain an `attributes` element that contains a list of
    possible modifiers. Currently defined values are:
    
    * `link` -- indicates that the entry is a symbolic link. The contents
        of the file represent the path the link points to.
    * `executable` -- indicates that the file has the executable bit set.
    * `subrepository` -- indicates that the entry points to a submodule or
        subrepo. The contents of the file is the SHA1 of the repository
        pointed to.
    * `binary` -- indicates whether Bitbucket thinks the file is binary.
    
    This endpoint can provide an alternative to how a HEAD request can be
    used to check for the existence of a file, or a file's size without
    incurring the overhead of receiving its full contents.
    
    
    #### Directory listings
    
    When `path` points to a directory instead of a file, the response is a
    paginated list of directory and file objects in the same order as the
    underlying SCM system would return them.
    
    For example:
    
    ```javascript
    $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests
    {
      "pagelen": 10,
      "values": [
        {
          "path": "tests/test_project",
          "type": "commit_directory",
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/"
            },
            "meta": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta"
            }
          },
          "commit": {
            "type": "commit",
            "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
              },
              "html": {
                "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
              }
            }
          }
        },
        {
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py"
            },
            "meta": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta"
            }
          },
          "path": "tests/__init__.py",
          "commit": {
            "type": "commit",
            "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
              },
              "html": {
                "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
              }
            }
          },
          "attributes": [],
          "type": "commit_file",
          "size": 0
        }
      ],
      "page": 1,
      "size": 2
    }
    ```
    
    When listing the contents of the repo's root directory, the use of a
    trailing slash at the end of the URL is required.
    
    The response by default is not recursive, meaning that only the direct contents of
    a path are returned. The response does not recurse down into
    subdirectories. In order to "walk" the entire directory tree, the
    client can either parse each response and follow the `self` links of each
    `commit_directory` object, or can specify a `max_depth` to recurse to.
    
    The max_depth parameter will do a breadth-first search to return the contents of the subdirectories
    up to the depth specified. Breadth-first search was chosen as it leads to the least amount of
    file system operations for git. If the `max_depth` parameter is specified to be too
    large, the call will time out and return a 555.
    
    Each returned object is either a `commit_file`, or a `commit_directory`,
    both of which contain a `path` element. This path is the absolute path
    from the root of the repository. Each object also contains a `commit`
    object which embeds the commit the file is on. Note that this is merely
    the commit that was used in the URL. It is *not* the commit that last
    modified the file.
    
    Directory objects have 2 representations. Their `self` link returns the
    paginated contents of the directory. The `meta` link on the other hand
    returns the actual `directory` object itself, e.g.:
    
    ```javascript
    {
      "path": "tests/test_project",
      "type": "commit_directory",
      "links": {
        "self": {
          "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/"
        },
        "meta": {
          "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta"
        }
      },
      "commit": { ... }
    }
    ```
    
    #### Querying, filtering and sorting
    
    Like most API endpoints, this API supports the Bitbucket
    querying/filtering syntax and so you could filter a directory listing
    to only include entries that match certain criteria. For instance, to
    list all binary files over 1kb use the expression:
    
    `size > 1024 and attributes = "binary"`
    
    which after urlencoding yields the query string:
    
    `?q=size%3E1024+and+attributes%3D%22binary%22`
    
    To change the ordering of the response, use the `?sort` parameter:
    
    `.../src/eefd5ef/?sort=-size`
    
    See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more
    details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commit: string;
              path: string;
              repo_slug: string;
              workspace: string;
          };
          query?: {
              format?: "meta" | "rendered";
              max_depth?: number;
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        }
        • Readonlycommit: string

          The commit's SHA1.

        • Readonlypath: string

          Path to the file.

        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            format?: "meta" | "rendered";
            max_depth?: number;
            q?: string;
            sort?: string;
        }
        • Optional Readonlyformat?: "meta" | "rendered"

          If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: .md, .markdown, .mkd, .mkdn, .mdown, .text, .rst, and .textile. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.

        • Optional Readonlymax_depth?: number

          If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.

        • Optional Readonlyq?: string

          Optional filter expression as per filtering and sorting.

        • Optional Readonlysort?: string

          Optional sorting parameter as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          commit?: (...) | (...);
                          path?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          555: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        commit?: (...) | (...);
                        path?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the path matches a file, then the raw contents of the file are returned. If the format=meta query parameter is provided, a json document containing the file's meta data is returned. If the format=rendered query parameter is provided, the contents of the file in HTML-formated rendered markup is returned. If the path matches a directory, then a paginated list of file and directory entries is returned (if the format=meta query parameter was provided, then the json document containing the directory's meta data is returned.)

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      commit?: (...) | (...);
                      path?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    commit?: (...) | (...);
                    path?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  commit?: (...) | (...);
                  path?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the path or commit in the URL does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly555: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the call times out, possibly because the specified recursion depth is too large.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            commit: string;
            path: string;
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          commit: string;
          path: string;
          repo_slug: string;
          workspace: string;
      }
      • Readonlycommit: string

        The commit's SHA1.

      • Readonlypath: string

        Path to the file.

      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/versions: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "version";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List defined versions for issues

    Returns the versions that have been defined in the issue tracker.

    This resource is only available on repositories that have the issue
    tracker enabled.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "version";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          id?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "version";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The versions that have been defined in the issue tracker.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "version";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      id?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "version";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    id?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "version";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  id?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/versions/{version_id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                version_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "version";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            version_id: number;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                version_id: number;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "version";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        id?: number;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a defined version for issues

    Returns the specified issue tracker version object.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              version_id: number;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            version_id: number;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyversion_id: number

          The version's id

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "version";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      id?: number;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "version";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    id?: number;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified version object.

        • content: {
              application/json: {
                  type: "version";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  id?: number;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "version";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                id?: number;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified repository or version does not exist or does not have the issue tracker enabled.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            version_id: number;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          version_id: number;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyversion_id: number

        The version's id

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/repositories/{workspace}/{repo_slug}/watchers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List repositories watchers

    Returns a paginated list of all the watchers on the specified repository.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of all the watchers on the specified repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                role?: "contributor" | "member" | "owner";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    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: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                role?: "contributor" | "member" | "owner";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List snippets

    Returns all snippets. Like pull requests, repositories and workspaces, the full set of snippets is defined by what the current user has access to.

    This includes all snippets owned by any of the workspaces the user is a member of,
    or snippets by other users that the current user is either watching or has collaborated
    on (for instance by commenting on it).
    
    To limit the set of returned snippets, apply the
    `?role=[owner|contributor|member]` query parameter where the roles are
    defined as follows:
    
    * `owner`: all snippets owned by the current user
    * `contributor`: all snippets owned by, or watched by the current user
    * `member`: created in a workspaces or watched by the current user
    
    When no role is specified, all public snippets are returned, as well as all
    privately owned snippets watched or commented on.
    
    The returned response is a normal paginated JSON list. This endpoint
    only supports `application/json` responses and no
    `multipart/form-data` or `multipart/related`. As a result, it is not
    possible to include the file contents.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              role?: "contributor" | "member" | "owner";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: {
            role?: "contributor" | "member" | "owner";
        }
        • Optional Readonlyrole?: "contributor" | "member" | "owner"

          Filter down the result based on the authenticated user's role (owner, contributor, or member).

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of snippets.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "snippet";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  creator?: (...) | (...);
                  id?: (...) | (...);
                  is_private?: (...) | (...) | (...);
                  owner?: (...) | (...);
                  scm?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a snippet

    Creates a new snippet under the authenticated user's account.

    Snippets can contain multiple files. Both text and binary files are
    supported.
    
    The simplest way to create a new snippet from a local file:
    
        $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets               -F file=@image.png
    
    Creating snippets through curl has a few limitations and so let's look
    at a more complicated scenario.
    
    Snippets are created with a multipart POST. Both `multipart/form-data`
    and `multipart/related` are supported. Both allow the creation of
    snippets with both meta data (title, etc), as well as multiple text
    and binary files.
    
    The main difference is that `multipart/related` can use rich encoding
    for the meta data (currently JSON).
    
    
    multipart/related (RFC-2387)
    ----------------------------
    
    This is the most advanced and efficient way to create a paste.
    
        POST /2.0/snippets/evzijst HTTP/1.1
        Content-Length: 1188
        Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
        MIME-Version: 1.0
    
        --===============1438169132528273974==
        Content-Type: application/json; charset="utf-8"
        MIME-Version: 1.0
        Content-ID: snippet
    
        {
          "title": "My snippet",
          "is_private": true,
          "scm": "git",
          "files": {
              "foo.txt": {},
              "image.png": {}
            }
        }
    
        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "foo.txt"
        Content-Disposition: attachment; filename="foo.txt"
    
        foo
    
        --===============1438169132528273974==
        Content-Type: image/png
        MIME-Version: 1.0
        Content-Transfer-Encoding: base64
        Content-ID: "image.png"
        Content-Disposition: attachment; filename="image.png"
    
        iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
        TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
        cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
        EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
        73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
        AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
        --===============1438169132528273974==--
    
    The request contains multiple parts and is structured as follows.
    
    The first part is the JSON document that describes the snippet's
    properties or meta data. It either has to be the first part, or the
    request's `Content-Type` header must contain the `start` parameter to
    point to it.
    
    The remaining parts are the files of which there can be zero or more.
    Each file part should contain the `Content-ID` MIME header through
    which the JSON meta data's `files` element addresses it. The value
    should be the name of the file.
    
    `Content-Disposition` is an optional MIME header. The header's
    optional `filename` parameter can be used to specify the file name
    that Bitbucket should use when writing the file to disk. When present,
    `filename` takes precedence over the value of `Content-ID`.
    
    When the JSON body omits the `files` element, the remaining parts are
    not ignored. Instead, each file is added to the new snippet as if its
    name was explicitly linked (the use of the `files` elements is
    mandatory for some operations like deleting or renaming files).
    
    
    multipart/form-data
    -------------------
    
    The use of JSON for the snippet's meta data is optional. Meta data can
    also be supplied as regular form fields in a more conventional
    `multipart/form-data` request:
    
        $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets               -F title="My snippet"               -F file=@foo.txt -F file=@image.png
    
        POST /2.0/snippets HTTP/1.1
        Content-Length: 951
        Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f
    
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="file"; filename="foo.txt"
        Content-Type: text/plain
    
        foo
    
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="file"; filename="image.png"
        Content-Type: application/octet-stream
    
        ?PNG
    
        IHDR?1??I.....
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="title"
    
        My snippet
        ------------------------------63a4b224c59f--
    
    Here the meta data properties are included as flat, top-level form
    fields. The file attachments use the `file` field name. To attach
    multiple files, simply repeat the field.
    
    The advantage of `multipart/form-data` over `multipart/related` is
    that it can be easier to build clients.
    
    Essentially all properties are optional, `title` and `files` included.
    
    
    Sharing and Visibility
    ----------------------
    
    Snippets can be either public (visible to anyone on Bitbucket, as well
    as anonymous users), or private (visible only to members of the workspace).
    This is controlled through the snippet's `is_private` element:
    
    * **is_private=false** -- everyone, including anonymous users can view
      the snippet
    * **is_private=true** -- only workspace members can view the snippet
    
    To create the snippet under a workspace, just append the workspace ID
    to the URL. See [`/2.0/snippets/{workspace}`](/cloud/bitbucket/rest/api-group-snippets/#api-snippets-workspace-post).
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "snippet";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              creator?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              id?: number;
              is_private?: boolean;
              owner?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              scm?: "git";
              title?: string;
              updated_on?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created snippet.

      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                role?: "contributor" | "member" | "owner";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                role?: "contributor" | "member" | "owner";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List snippets in a workspace

    Identical to /snippets, except that the result is further filtered by the snippet owner and only those that are owned by {workspace} are returned.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: {
              role?: "contributor" | "member" | "owner";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            role?: "contributor" | "member" | "owner";
        }
        • Optional Readonlyrole?: "contributor" | "member" | "owner"

          Filter down the result based on the authenticated user's role (owner, contributor, or member).

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of snippets.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "snippet";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  creator?: (...) | (...);
                  id?: (...) | (...);
                  is_private?: (...) | (...) | (...);
                  owner?: (...) | (...);
                  scm?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the user does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a snippet for a workspace

    Identical to /snippets, except that the new snippet will be created under the workspace specified in the path parameter {workspace}.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "snippet";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              creator?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              id?: number;
              is_private?: boolean;
              owner?: {
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              };
              scm?: "git";
              title?: string;
              updated_on?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created snippet.

      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to create snippets in the specified workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a snippet

    Deletes a snippet and returns an empty response.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet was deleted successfully.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have permission to delete the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            410: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a snippet

    Retrieves a single snippet.

    Snippets support multiple content types:
    
    * application/json
    * multipart/related
    * multipart/form-data
    
    
    application/json
    ----------------
    
    The default content type of the response is `application/json`.
    Since JSON is always `utf-8`, it cannot reliably contain file contents
    for files that are not text. Therefore, JSON snippet documents only
    contain the filename and links to the file contents.
    
    This means that in order to retrieve all parts of a snippet, N+1
    requests need to be made (where N is the number of files in the
    snippet).
    
    
    multipart/related
    -----------------
    
    To retrieve an entire snippet in a single response, use the
    `Accept: multipart/related` HTTP request header.
    
        $ curl -H "Accept: multipart/related" https://api.bitbucket.org/2.0/snippets/evzijst/1
    
    Response:
    
        HTTP/1.1 200 OK
        Content-Length: 2214
        Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
        MIME-Version: 1.0
    
        --===============1438169132528273974==
        Content-Type: application/json; charset="utf-8"
        MIME-Version: 1.0
        Content-ID: snippet
    
        {
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj"
            },
            "html": {
              "href": "https://bitbucket.org/snippets/evzijst/kypj"
            },
            "comments": {
              "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments"
            },
            "watchers": {
              "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers"
            },
            "commits": {
              "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits"
            }
          },
          "id": kypj,
          "title": "My snippet",
          "created_on": "2014-12-29T22:22:04.790331+00:00",
          "updated_on": "2014-12-29T22:22:04.790331+00:00",
          "is_private": false,
          "files": {
            "foo.txt": {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt"
                },
                "html": {
                  "href": "https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt"
                }
              }
            },
            "image.png": {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png"
                },
                "html": {
                  "href": "https://bitbucket.org/snippets/evzijst/kypj#file-image.png"
                }
              }
            }
          ],
          "owner": {
            "username": "evzijst",
            "nickname": "evzijst",
            "display_name": "Erik van Zijst",
            "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/users/evzijst"
              },
              "html": {
                "href": "https://bitbucket.org/evzijst"
              },
              "avatar": {
                "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png"
              }
            }
          },
          "creator": {
            "username": "evzijst",
            "nickname": "evzijst",
            "display_name": "Erik van Zijst",
            "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/users/evzijst"
              },
              "html": {
                "href": "https://bitbucket.org/evzijst"
              },
              "avatar": {
                "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png"
              }
            }
          }
        }
    
        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "foo.txt"
        Content-Disposition: attachment; filename="foo.txt"
    
        foo
    
        --===============1438169132528273974==
        Content-Type: image/png
        MIME-Version: 1.0
        Content-Transfer-Encoding: base64
        Content-ID: "image.png"
        Content-Disposition: attachment; filename="image.png"
    
        iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
        TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
        cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
        EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
        73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
        AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
        --===============1438169132528273974==--
    
    multipart/form-data
    -------------------
    
    As with creating new snippets, `multipart/form-data` can be used as an
    alternative to `multipart/related`. However, the inherently flat
    structure of form-data means that only basic, root-level properties
    can be returned, while nested elements like `links` are omitted:
    
        $ curl -H "Accept: multipart/form-data" https://api.bitbucket.org/2.0/snippets/evzijst/kypj
    
    Response:
    
        HTTP/1.1 200 OK
        Content-Length: 951
        Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f
    
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="title"
        Content-Type: text/plain; charset="utf-8"
    
        My snippet
        ------------------------------63a4b224c59f--
        Content-Disposition: attachment; name="file"; filename="foo.txt"
        Content-Type: text/plain
    
        foo
    
        ------------------------------63a4b224c59f
        Content-Disposition: attachment; name="file"; filename="image.png"
        Content-Transfer-Encoding: base64
        Content-Type: application/octet-stream
    
        iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
        TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
        cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
        EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
        73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
        AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
        ------------------------------5957323a6b76--
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/form-data: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/related: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          410: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/form-data: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/related: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/form-data: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/related: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/form-data: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/related: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have access to the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly410: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet marked as spam.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a snippet

    Used to update a snippet. Use this to add and delete files and to change a snippet's title.

    To update a snippet, one can either PUT a full snapshot, or only the
    parts that need to be changed.
    
    The contract for PUT on this API is that properties missing from the
    request remain untouched so that snippets can be efficiently
    manipulated with differential payloads.
    
    To delete a property (e.g. the title, or a file), include its name in
    the request, but omit its value (use `null`).
    
    As in Git, explicit renaming of files is not supported. Instead, to
    rename a file, delete it and add it again under another name. This can
    be done atomically in a single request. Rename detection is left to
    the SCM.
    
    PUT supports three different content types for both request and
    response bodies:
    
    * `application/json`
    * `multipart/related`
    * `multipart/form-data`
    
    The content type used for the request body can be different than that
    used for the response. Content types are specified using standard HTTP
    headers.
    
    Use the `Content-Type` and `Accept` headers to select the desired
    request and response format.
    
    
    application/json
    ----------------
    
    As with creation and retrieval, the content type determines what
    properties can be manipulated. `application/json` does not support
    file contents and is therefore limited to a snippet's meta data.
    
    To update the title, without changing any of its files:
    
        $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj             -d '{"title": "Updated title"}'
    
    
    To delete the title:
    
        $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj             -d '{"title": null}'
    
    Not all parts of a snippet can be manipulated. The owner and creator
    for instance are immutable.
    
    
    multipart/related
    -----------------
    
    `multipart/related` can be used to manipulate all of a snippet's
    properties. The body is identical to a POST. properties omitted from
    the request are left unchanged. Since the `start` part contains JSON,
    the mechanism for manipulating the snippet's meta data is identical
    to `application/json` requests.
    
    To update one of a snippet's file contents, while also changing its
    title:
    
        PUT /2.0/snippets/evzijst/kypj HTTP/1.1
        Content-Length: 288
        Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
        MIME-Version: 1.0
    
        --===============1438169132528273974==
        Content-Type: application/json; charset="utf-8"
        MIME-Version: 1.0
        Content-ID: snippet
    
        {
          "title": "My updated snippet",
          "files": {
              "foo.txt": {}
            }
        }
    
        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "foo.txt"
        Content-Disposition: attachment; filename="foo.txt"
    
        Updated file contents.
    
        --===============1438169132528273974==--
    
    Here only the parts that are changed are included in the body. The
    other files remain untouched.
    
    Note the use of the `files` list in the JSON part. This list contains
    the files that are being manipulated. This list should have
    corresponding multiparts in the request that contain the new contents
    of these files.
    
    If a filename in the `files` list does not have a corresponding part,
    it will be deleted from the snippet, as shown below:
    
        PUT /2.0/snippets/evzijst/kypj HTTP/1.1
        Content-Length: 188
        Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
        MIME-Version: 1.0
    
        --===============1438169132528273974==
        Content-Type: application/json; charset="utf-8"
        MIME-Version: 1.0
        Content-ID: snippet
    
        {
          "files": {
            "image.png": {}
          }
        }
    
        --===============1438169132528273974==--
    
    To simulate a rename, delete a file and add the same file under
    another name:
    
        PUT /2.0/snippets/evzijst/kypj HTTP/1.1
        Content-Length: 212
        Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
        MIME-Version: 1.0
    
        --===============1438169132528273974==
        Content-Type: application/json; charset="utf-8"
        MIME-Version: 1.0
        Content-ID: snippet
    
        {
            "files": {
              "foo.txt": {},
              "bar.txt": {}
            }
        }
    
        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "bar.txt"
        Content-Disposition: attachment; filename="bar.txt"
    
        foo
    
        --===============1438169132528273974==--
    
    
    multipart/form-data
    -----------------
    
    Again, one can also use `multipart/form-data` to manipulate file
    contents and meta data atomically.
    
        $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj             -F title="My updated snippet" -F file=@foo.txt
    
        PUT /2.0/snippets/evzijst/kypj HTTP/1.1
        Content-Length: 351
        Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f
    
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="file"; filename="foo.txt"
        Content-Type: text/plain
    
        foo
    
        ------------------------------63a4b224c59f
        Content-Disposition: form-data; name="title"
    
        My updated snippet
        ------------------------------63a4b224c59f
    
    To delete a file, omit its contents while including its name in the
    `files` field:
    
        $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png
    
        PUT /2.0/snippets/evzijst/kypj HTTP/1.1
        Content-Length: 149
        Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86
    
        ------------------------------ef8871065a86
        Content-Disposition: form-data; name="files"
    
        image.png
        ------------------------------ef8871065a86--
    
    The explicit use of the `files` element in `multipart/related` and
    `multipart/form-data` is only required when deleting files.
    The default mode of operation is for file parts to be processed,
    regardless of whether or not they are listed in `files`, as a
    convenience to the client.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/form-data: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/related: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/form-data: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/related: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/form-data: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/related: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/form-data: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/related: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have permission to update the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/{node_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            405: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            node_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            405: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            405: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a previous revision of a snippet

    Deletes the snippet.

    Note that this only works for versioned URLs that point to the latest
    commit of the snippet. Pointing to an older commit results in a 405
    status code.
    
    To delete a snippet, regardless of whether or not concurrent changes
    are being made to it, use `DELETE /snippets/{encoded_id}` instead.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              node_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            node_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlynode_id: string

          A commit revision (SHA1).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          405: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet was deleted successfully.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have permission to delete the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly405: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If {node_id} is not the latest revision.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a previous revision of a snippet

    Identical to GET /snippets/encoded_id, except that this endpoint can be used to retrieve the contents of the snippet as it was at an older revision, while /snippets/encoded_id always returns the snippet's current revision.

    Note that only the snippet's file contents are versioned, not its
    meta data properties like the title.
    
    Other than that, the two endpoints are identical in behavior.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              node_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            node_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlynode_id: string

          A commit revision (SHA1).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/form-data: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/related: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/form-data: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/related: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/form-data: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/related: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/form-data: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/related: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have access to the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet, or the revision does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            node_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          node_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlynode_id: string

        A commit revision (SHA1).

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/form-data: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                    multipart/related: {
                        type: "snippet";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        id?: number;
                        is_private?: boolean;
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            405: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/form-data: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                    multipart/related: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a previous revision of a snippet

    Identical to UPDATE /snippets/encoded_id, except that this endpoint takes an explicit commit revision. Only the snippet's "HEAD"/"tip" (most recent) version can be updated and requests on all other, older revisions fail by returning a 405 status.

    Usage of this endpoint over the unrestricted `/snippets/encoded_id`
    could be desired if the caller wants to be sure no concurrent
    modifications have taken place between the moment of the UPDATE
    request and the original GET.
    
    This can be considered a so-called "Compare And Swap", or CAS
    operation.
    
    Other than that, the two endpoints are identical in behavior.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              node_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            node_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlynode_id: string

          A commit revision (SHA1).

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/form-data: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
                  multipart/related: {
                      type: "snippet";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      id?: number;
                      is_private?: boolean;
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          405: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/form-data: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
                  multipart/related: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/form-data: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
                multipart/related: {
                    type: "snippet";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    id?: number;
                    is_private?: boolean;
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated snippet object.

        • content: {
              application/json: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/form-data: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
              multipart/related: {
                  type: "snippet";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  id?: number;
                  is_private?: boolean;
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/form-data: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
          • Readonlymultipart/related: {
                type: "snippet";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                creator?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                id?: number;
                is_private?: boolean;
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                scm?: "git";
                title?: string;
                updated_on?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet is private and the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If authenticated user does not have permission to update the private snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet or the revision does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly405: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/form-data: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
                multipart/related: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If {node_id} is not the latest revision.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/form-data: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
              multipart/related: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/form-data: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
          • Readonlymultipart/related: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: {
                    Content-Disposition?: string;
                    Content-Type?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            node_id: string;
            path: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                node_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: {
                    Content-Disposition?: string;
                    Content-Type?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a snippet's raw file

    Retrieves the raw contents of a specific file in the snippet. The Content-Disposition header will be "attachment" to avoid issues with malevolent executable files.

    The file's mime type is derived from its filename and returned in the
    `Content-Type` header.
    
    Note that for text files, no character encoding is included as part of
    the content type.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              node_id: string;
              path: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            node_id: string;
            path: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlynode_id: string

          A commit revision (SHA1).

        • Readonlypath: string

          Path to the file.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: {
                  Content-Disposition?: string;
                  Content-Type?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: {
                Content-Disposition?: string;
                Content-Type?: string;
                [name: string]: unknown;
            };
        }

        Returns the contents of the specified file.

        • Optionalcontent?: undefined
        • headers: {
              Content-Disposition?: string;
              Content-Type?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyContent-Disposition?: string

            attachment

          • Optional ReadonlyContent-Type?: string

            The mime type as derived from the filename

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the file or snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            node_id: string;
            path: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          node_id: string;
          path: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlynode_id: string

        A commit revision (SHA1).

      • Readonlypath: string

        Path to the file.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/{revision}/diff: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: {
                path?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: {
                path?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get snippet changes between versions

    Returns the diff of the specified commit against its first parent.

    Note that this resource is different in functionality from the `patch`
    resource.
    
    The differences between a diff and a patch are:
    
    * patches have a commit header with the username, message, etc
    * diffs support the optional `path=foo/bar.py` query param to filter the
      diff to just that one file diff (not supported for patches)
    * for a merge, the diff will show the diff between the merge commit and
      its first parent (identical to how PRs work), while patch returns a
      response containing separate patches for each commit on the second
      parent's ancestry, up to the oldest common ancestor (identical to
      its reachability).
    
    Note that the character encoding of the contents of the diff is
    unspecified as Git does not track this, making it hard for
    Bitbucket to reliably determine this.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              revision: string;
              workspace: string;
          };
          query?: {
              path?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            revision: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyrevision: string

          A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like staging..production.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            path?: string;
        }
        • Optional Readonlypath?: string

          When used, only one the diff of the specified file will be returned.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw diff contents.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          revision: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyrevision: string

        A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like staging..production.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/{revision}/patch: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get snippet patch between versions

    Returns the patch of the specified commit against its first parent.

    Note that this resource is different in functionality from the `diff`
    resource.
    
    The differences between a diff and a patch are:
    
    * patches have a commit header with the username, message, etc
    * diffs support the optional `path=foo/bar.py` query param to filter the
      diff to just that one file diff (not supported for patches)
    * for a merge, the diff will show the diff between the merge commit and
      its first parent (identical to how PRs work), while patch returns a
      response containing separate patches for each commit on the second
      parent's ancestry, up to the oldest common ancestor (identical to
      its reachability).
    
    Note that the character encoding of the contents of the patch is
    unspecified as Git does not track this, making it hard for
    Bitbucket to reliably determine this.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              revision: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            revision: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyrevision: string

          A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like staging..production.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The raw patch contents.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          revision: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyrevision: string

        A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like staging..production.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/comments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet_comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            snippet?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: (...) & (...) & (...) & (...);
                        id?: number;
                        is_private?: boolean;
                        owner?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet_comment";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            snippet?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List comments on a snippet

    Used to retrieve a paginated list of all comments for a specific snippet.

    This resource works identical to commit and pull request comments.
    
    The default sorting is oldest to newest and can be overridden with
    the `sort` query parameter.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "snippet_comment";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          snippet?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "snippet_comment";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        snippet?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A paginated list of snippet comments, ordered by creation date.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "snippet_comment";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      snippet?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "snippet_comment";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    snippet?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "snippet_comment";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  snippet?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: (...) & (...) & (...) & (...);
                        id?: number;
                        is_private?: boolean;
                        owner?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a comment on a snippet

    Creates a new comment.

    The only required field in the body is `content.raw`.
    
    To create a threaded reply to an existing comment, include `parent.id`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "snippet_comment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: (...) & (...) & (...) & (...);
                      id?: number;
                      is_private?: boolean;
                      owner?: (...) & (...) & (...) & (...);
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
          };
      }

      The contents of the new comment.

      • Readonlycontent: {
            application/json: {
                type: "snippet_comment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: (...) & (...) & (...) & (...);
                    id?: number;
                    is_private?: boolean;
                    owner?: (...) & (...) & (...) & (...);
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "snippet_comment";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              links?: {
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              snippet?: {
                  type: "snippet";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: (...) & (...) & (...) & (...);
                  id?: number;
                  is_private?: boolean;
                  owner?: (...) & (...) & (...) & (...);
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "snippet_comment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      snippet?: {
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The newly created comment.

        • content: {
              application/json: {
                  type: "snippet_comment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "snippet_comment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the new comment

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/comments/{comment_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: (...) & (...) & (...) & (...);
                        id?: number;
                        is_private?: boolean;
                        owner?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a comment on a snippet

    Deletes a snippet comment.

    Comments can only be removed by the comment author, snippet creator, or workspace admin.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            encoded_id: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates the comment was deleted successfully.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is not the author of the comment.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment or the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a comment on a snippet

    Returns the specific snippet comment.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            encoded_id: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet_comment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      snippet?: {
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified comment.

        • content: {
              application/json: {
                  type: "snippet_comment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "snippet_comment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment or snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            comment_id: number;
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          comment_id: number;
          encoded_id: string;
          workspace: string;
      }
      • Readonlycomment_id: number

        The id of the comment.

      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                comment_id: number;
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        self?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        creator?: (...) & (...) & (...) & (...);
                        id?: number;
                        is_private?: boolean;
                        owner?: (...) & (...) & (...) & (...);
                        scm?: "git";
                        title?: string;
                        updated_on?: string;
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_comment";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a comment on a snippet

    Updates a comment.

    The only required field in the body is `content.raw`.
    
    Comments can only be updated by their author.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              comment_id: number;
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            comment_id: number;
            encoded_id: string;
            workspace: string;
        }
        • Readonlycomment_id: number

          The id of the comment.

        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "snippet_comment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      self?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      creator?: (...) & (...) & (...) & (...);
                      id?: number;
                      is_private?: boolean;
                      owner?: (...) & (...) & (...) & (...);
                      scm?: "git";
                      title?: string;
                      updated_on?: string;
                  };
              };
          };
      }

      The contents to update the comment to.

      • Readonlycontent: {
            application/json: {
                type: "snippet_comment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    self?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    creator?: (...) & (...) & (...) & (...);
                    id?: number;
                    is_private?: boolean;
                    owner?: (...) & (...) & (...) & (...);
                    scm?: "git";
                    title?: string;
                    updated_on?: string;
                };
            };
        }
        • Readonlyapplication/json: {
              type: "snippet_comment";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              links?: {
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  self?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              snippet?: {
                  type: "snippet";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  creator?: (...) & (...) & (...) & (...);
                  id?: number;
                  is_private?: boolean;
                  owner?: (...) & (...) & (...) & (...);
                  scm?: "git";
                  title?: string;
                  updated_on?: string;
              };
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet_comment";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: {
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      snippet?: {
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet_comment";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated comment object.

        • content: {
              application/json: {
                  type: "snippet_comment";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "snippet_comment";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the comment or snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/commits: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet_commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            snippet?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "snippet_commit";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            snippet?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List snippet changes

    Returns the changes (commits) made on this snippet.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "snippet_commit";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          snippet?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "snippet_commit";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        snippet?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of snippet commits.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "snippet_commit";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      snippet?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "snippet_commit";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    snippet?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "snippet_commit";
              } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  snippet?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/commits/{revision}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                revision: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "snippet_commit";
                    } & Omit<{
                        type: "base_commit";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        author?: (...) & (...) & (...) & (...);
                        date?: string;
                        hash?: string;
                        message?: string;
                        parents?: readonly (...)[];
                        summary?: {
                            html?: ...;
                            markup?: ...;
                            raw?: ...;
                        };
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            diff?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        snippet?: {
                            type: "snippet";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            creator?: (...) | (...);
                            id?: (...) | (...);
                            is_private?: (...) | (...) | (...);
                            owner?: (...) | (...);
                            scm?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a previous snippet change

    Returns the changes made on this snippet in this commit.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              revision: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            revision: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyrevision: string

          The commit's SHA1.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "snippet_commit";
                  } & Omit<{
                      type: "base_commit";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      author?: (...) & (...) & (...) & (...);
                      date?: string;
                      hash?: string;
                      message?: string;
                      parents?: readonly (...)[];
                      summary?: {
                          html?: ...;
                          markup?: ...;
                          raw?: ...;
                      };
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: {
                          diff?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      snippet?: {
                          type: "snippet";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          creator?: (...) | (...);
                          id?: (...) | (...);
                          is_private?: (...) | (...) | (...);
                          owner?: (...) | (...);
                          scm?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "snippet_commit";
                } & Omit<{
                    type: "base_commit";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    author?: (...) & (...) & (...) & (...);
                    date?: string;
                    hash?: string;
                    message?: string;
                    parents?: readonly (...)[];
                    summary?: {
                        html?: ...;
                        markup?: ...;
                        raw?: ...;
                    };
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        diff?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    snippet?: {
                        type: "snippet";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        creator?: (...) | (...);
                        id?: (...) | (...);
                        is_private?: (...) | (...) | (...);
                        owner?: (...) | (...);
                        scm?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified snippet commit.

        • content: {
              application/json: {
                  type: "snippet_commit";
              } & Omit<{
                  type: "base_commit";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  author?: (...) & (...) & (...) & (...);
                  date?: string;
                  hash?: string;
                  message?: string;
                  parents?: readonly (...)[];
                  summary?: {
                      html?: ...;
                      markup?: ...;
                      raw?: ...;
                  };
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      diff?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  snippet?: {
                      type: "snippet";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      creator?: (...) | (...);
                      id?: (...) | (...);
                      is_private?: (...) | (...) | (...);
                      owner?: (...) | (...);
                      scm?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "snippet_commit";
            } & Omit<{
                type: "base_commit";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                author?: (...) & (...) & (...) & (...);
                date?: string;
                hash?: string;
                message?: string;
                parents?: readonly (...)[];
                summary?: {
                    html?: ...;
                    markup?: ...;
                    raw?: ...;
                };
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    diff?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                snippet?: {
                    type: "snippet";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    creator?: (...) | (...);
                    id?: (...) | (...);
                    is_private?: (...) | (...) | (...);
                    owner?: (...) | (...);
                    scm?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the commit or the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            revision: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          revision: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyrevision: string

        The commit's SHA1.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/files/{path}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            path: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                path: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            302: {
                content?: undefined;
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a snippet's raw file at HEAD

    Convenience resource for getting to a snippet's raw files without the need for first having to retrieve the snippet itself and having to pull out the versioned file links.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              path: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            path: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlypath: string

          Path to the file.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          302: {
              content?: undefined;
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly302: {
            content?: undefined;
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        A redirect to the most recent revision of the specified file.

        • Optionalcontent?: undefined
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the most recent file revision.

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have access to the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            path: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          path: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlypath: string

        Path to the file.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/watch: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Stop watching a snippet

    Used to stop watching a specific snippet. Returns 204 (No Content) to indicate success.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates the user stopped watching the snippet successfully.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Check if the current user is watching a snippet

    Used to check if the current user is watching a specific snippet.

    Returns 204 (No Content) if the user is watching the snippet and 404 if
    not.
    
    Hitting this endpoint anonymously always returns a 404.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is watching the snippet.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist, or if the authenticated user is not watching the snippet.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Watch a snippet

    Used to start watching a specific snippet. Returns 204 (No Content).

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Indicates the authenticated user is now watching the snippet.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/snippets/{workspace}/{encoded_id}/watchers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                encoded_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List users watching a snippet

    Returns a paginated list of all users watching a specific snippet.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              encoded_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            encoded_id: string;
            workspace: string;
        }
        • Readonlyencoded_id: string

          The snippet id.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of users watching this snippet

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the snippet does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            encoded_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          encoded_id: string;
          workspace: string;
      }
      • Readonlyencoded_id: string

        The snippet id.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/teams/{username}/pipelines_config/variables: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List variables for an account

    Find account level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
        }
        • Readonlyusername: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_variable";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          secured?: (...) | (...) | (...);
                          uuid?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The found account level variables.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a variable for a user

    Create an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
        }
        • Readonlyusername: string

          The account.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The created variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline variable.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A variable with the provided key already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/teams/{username}/pipelines_config/variables/{variable_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a variable for a team

    Delete a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
            variable_uuid: string;
        }
        • Readonlyusername: string

          The account.

        • Readonlyvariable_uuid: string

          The UUID of the variable to delete.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or the variable with the provided UUID does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a variable for a team

    Retrieve a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
            variable_uuid: string;
        }
        • Readonlyusername: string

          The account.

        • Readonlyvariable_uuid: string

          The UUID of the variable to retrieve.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a variable for a team

    Update a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
            variable_uuid: string;
        }
        • Readonlyusername: string

          The account.

        • Readonlyvariable_uuid: string

          The UUID of the variable.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was updated.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or the variable was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/teams/{username}/search/code: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                username: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Search for code in a team's repositories

    Search for code in the repositories of the specified team.

    Note that searches can match in the file's text (`content_matches`),
    the path (`path_matches`), or both.
    
    You can use the same syntax for the search query as in the UI.
    E.g. to search for "foo" only within the repository "demo",
    use the query parameter `search_query=foo+repo:demo`.
    
    Similar to other APIs, you can request more fields using a
    `fields` query parameter. E.g. to get some more information about
    the repository of matched files, use the query parameter
    `search_query=foo&fields=%2Bvalues.file.commit.repository`
    (the `%2B` is a URL-encoded `+`).
    
    Try `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              username: string;
          };
          query: {
              page?: number;
              pagelen?: number;
              search_query: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            username: string;
        }
        • Readonlyusername: string

          The account to search in; either the username or the UUID in curly braces

      • Readonlyquery: {
            page?: number;
            pagelen?: number;
            search_query: string;
        }
        • Optional Readonlypage?: number

          Which page of the search results to retrieve

        • Optional Readonlypagelen?: number

          How many search results to retrieve per page

        • Readonlysearch_query: string

          The search query

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      query_substituted?: boolean;
                      size?: number;
                      values?: readonly {
                          content_match_count?: number;
                          content_matches?: readonly (...)[];
                          file?: (...) & (...);
                          path_matches?: readonly (...)[];
                          type?: string;
                      }[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          429: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    query_substituted?: boolean;
                    size?: number;
                    values?: readonly {
                        content_match_count?: number;
                        content_matches?: readonly (...)[];
                        file?: (...) & (...);
                        path_matches?: readonly (...)[];
                        type?: string;
                    }[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Successful search

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  query_substituted?: boolean;
                  size?: number;
                  values?: readonly {
                      content_match_count?: number;
                      content_matches?: readonly (...)[];
                      file?: (...) & (...);
                      path_matches?: readonly (...)[];
                      type?: string;
                  }[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                query_substituted?: boolean;
                size?: number;
                values?: readonly {
                    content_match_count?: number;
                    content_matches?: readonly (...)[];
                    file?: (...) & (...);
                    path_matches?: readonly (...)[];
                    type?: string;
                }[];
            }
            • Optional Readonlynext?: string

              Format: uri

            • Optional Readonlypage?: number

              Format: int32

            • Optional Readonlypagelen?: number

              Format: int32

            • Optional Readonlyprevious?: string

              Format: uri

            • Optional Readonlyquery_substituted?: boolean
            • Optional Readonlysize?: number

              Format: int64

            • Optional Readonlyvalues?: readonly {
                  content_match_count?: number;
                  content_matches?: readonly (...)[];
                  file?: (...) & (...);
                  path_matches?: readonly (...)[];
                  type?: string;
              }[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the search request was invalid due to one of the following reasons:

        * the specified type of target account doesn''t match the actual
        account type;
        
        * malformed pagination properties;
        
        * missing or malformed search query, in the latter case an error
        key will be returned in `error.data.key` property.
        
        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Search is not enabled for the requested team, navigate to https://bitbucket.org/search to turn it on

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly429: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Too many requests, try again later

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/user: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get current user

    Returns the currently logged in user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "account";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "account";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The current user.

        • content: {
              application/json: {
                  type: "account";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "account";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When the request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/user/emails: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List email addresses for current user

    Returns all the authenticated user's email addresses. Both confirmed and unconfirmed.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          default: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonlydefault: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Unexpected error.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/user/emails/{email}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                email: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            email: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                email: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an email address for current user

    Returns details about a specific one of the authenticated user's email addresses.

    Details describe whether the address has been confirmed by the user and
    whether it is the user's primary address or not.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              email: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            email: string;
        }
        • Readonlyemail: string

          Email address of the user.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          default: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonlydefault: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Unexpected error.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            email: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          email: string;
      }
      • Readonlyemail: string

        Email address of the user.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/user/permissions/repositories: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List repository permissions for a user

    Returns an object for each repository the caller has explicit access to and their effective permission — the highest level of permission the caller has. This does not return public repositories that the user was not granted any specific permission in, and does not distinguish between explicit and implicit privileges.

    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    
    Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by
    repository or permission by adding the following query string
    parameters:
    
    * `q=repository.name="geordi"` or `q=permission>"read"`
    * `sort=repository.name`
    
    Note that the query parameter values need to be URL escaped so that `=`
    would become `%3D`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Name of a response property sort the result by as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          repository?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        repository?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Repository permissions for the repositories a caller has explicit access to.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      repository?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    repository?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  repository?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/user/permissions/workspaces: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List workspaces for the current user

    Returns an object for each workspace the caller is a member of, and their effective role - the highest level of privilege the caller has. If a user is a member of multiple groups with distinct roles, only the highest level is returned.

    Permissions can be:
    
    * `owner`
    * `collaborator`
    * `member`
    
    **The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,
    see the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**
    
    **When you move your administration from Bitbucket Cloud to admin.atlassian.com, the following fields on
    `workspace_membership` will no longer be present: `last_accessed` and `added_on`. See the
    [deprecation announcement](/cloud/bitbucket/announcement-breaking-change-workspace-membership/).**
    
    Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by
    workspace or permission by adding the following query string parameters:
    
    * `q=workspace.slug="bbworkspace1"` or `q=permission="owner"`
    * `sort=workspace.slug`
    
    Note that the query parameter values need to be URL escaped so that `=`
    would become `%3D`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response. See filtering and sorting for details.

        • Optional Readonlysort?: string

          Name of a response property to sort results. See filtering and sorting for details.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "workspace_membership";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          user?: (...) | (...);
                          workspace?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "workspace_membership";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        user?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All of the workspace memberships for the authenticated user.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "workspace_membership";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      user?: (...) | (...);
                      workspace?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "workspace_membership";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    user?: (...) | (...);
                    workspace?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "workspace_membership";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  user?: (...) | (...);
                  workspace?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/users/{selected_user}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "account";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        };
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a user

    Gets the public information associated with a user account.

    If the user's profile is private, `location`, `website` and
    `created_on` elements are omitted.
    
    Note that the user object returned by this operation is changing significantly, due to privacy changes.
    See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-bitbucket-user-objects) for details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "account";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      };
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "account";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    };
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user object

        • content: {
              application/json: {
                  type: "account";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  };
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "account";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                };
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If no user exists for the specified UUID, or if the specified account is a team account, not a personal account.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          selected_user: string;
      }
      • Readonlyselected_user: string

        This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/users/{selected_user}/pipelines_config/variables: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List variables for a user

    Find user level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_variable";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          secured?: (...) | (...) | (...);
                          uuid?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The found user level variables.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a variable for a user

    Create a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The created variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline variable.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A variable with the provided key already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/users/{selected_user}/pipelines_config/variables/{variable_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a variable for a user

    Delete an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
            variable_uuid: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

        • Readonlyvariable_uuid: string

          The UUID of the variable to delete.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or the variable with the provided UUID does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a variable for a user

    Retrieve a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
            variable_uuid: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

        • Readonlyvariable_uuid: string

          The UUID of the variable to retrieve.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                variable_uuid: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a variable for a user

    Update a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
              variable_uuid: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
            variable_uuid: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

        • Readonlyvariable_uuid: string

          The UUID of the variable.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was updated.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The account or the variable was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/users/{selected_user}/properties/{app_key}/{property_name}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a user application property

    Delete an application property value stored against a user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            selected_user: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        _attributes?: readonly ("public" | "read_only")[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a user application property

    Retrieve an application property value stored against a user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            selected_user: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      _attributes?: readonly ("public" | "read_only")[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The value of the property.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                app_key: string;
                property_name: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    _attributes?: readonly ("public" | "read_only")[];
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a user application property

    Update an application property value stored against a user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              app_key: string;
              property_name: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            app_key: string;
            property_name: string;
            selected_user: string;
        }
        • Readonlyapp_key: string

          The key of the Connect app.

        • Readonlyproperty_name: string

          The name of the property.

        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: Readonly<Record<string, unknown>> & {
                  _attributes?: readonly ("public" | "read_only")[];
              };
          };
      }
      • Readonlycontent: {
            application/json: Readonly<Record<string, unknown>> & {
                _attributes?: readonly ("public" | "read_only")[];
            };
        }
        • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
              _attributes?: readonly ("public" | "read_only")[];
          }
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        An empty response.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/users/{selected_user}/search/code: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Search for code in a user's repositories

    Search for code in the repositories of the specified user.

    Note that searches can match in the file's text (`content_matches`),
    the path (`path_matches`), or both.
    
    You can use the same syntax for the search query as in the UI.
    E.g. to search for "foo" only within the repository "demo",
    use the query parameter `search_query=foo+repo:demo`.
    
    Similar to other APIs, you can request more fields using a
    `fields` query parameter. E.g. to get some more information about
    the repository of matched files, use the query parameter
    `search_query=foo&fields=%2Bvalues.file.commit.repository`
    (the `%2B` is a URL-encoded `+`).
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query: {
              page?: number;
              pagelen?: number;
              search_query: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

      • Readonlyquery: {
            page?: number;
            pagelen?: number;
            search_query: string;
        }
        • Optional Readonlypage?: number

          Which page of the search results to retrieve

        • Optional Readonlypagelen?: number

          How many search results to retrieve per page

        • Readonlysearch_query: string

          The search query

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      query_substituted?: boolean;
                      size?: number;
                      values?: readonly {
                          content_match_count?: number;
                          content_matches?: readonly (...)[];
                          file?: (...) & (...);
                          path_matches?: readonly (...)[];
                          type?: string;
                      }[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          429: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    query_substituted?: boolean;
                    size?: number;
                    values?: readonly {
                        content_match_count?: number;
                        content_matches?: readonly (...)[];
                        file?: (...) & (...);
                        path_matches?: readonly (...)[];
                        type?: string;
                    }[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Successful search

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  query_substituted?: boolean;
                  size?: number;
                  values?: readonly {
                      content_match_count?: number;
                      content_matches?: readonly (...)[];
                      file?: (...) & (...);
                      path_matches?: readonly (...)[];
                      type?: string;
                  }[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                query_substituted?: boolean;
                size?: number;
                values?: readonly {
                    content_match_count?: number;
                    content_matches?: readonly (...)[];
                    file?: (...) & (...);
                    path_matches?: readonly (...)[];
                    type?: string;
                }[];
            }
            • Optional Readonlynext?: string

              Format: uri

            • Optional Readonlypage?: number

              Format: int32

            • Optional Readonlypagelen?: number

              Format: int32

            • Optional Readonlyprevious?: string

              Format: uri

            • Optional Readonlyquery_substituted?: boolean
            • Optional Readonlysize?: number

              Format: int64

            • Optional Readonlyvalues?: readonly {
                  content_match_count?: number;
                  content_matches?: readonly (...)[];
                  file?: (...) & (...);
                  path_matches?: readonly (...)[];
                  type?: string;
              }[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the search request was invalid due to one of the following reasons:

        * the specified type of target account doesn''t match the actual
        account type;
        
        * malformed pagination properties;
        
        * missing or malformed search query, in the latter case an error
        key will be returned in `error.data.key` property.
        
        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Search is not enabled for the requested user, navigate to https://bitbucket.org/search to turn it on

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly429: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Too many requests, try again later

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/users/{selected_user}/ssh-keys: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "ssh_account_key";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            owner?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "ssh_account_key";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            owner?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List SSH keys

    Returns a paginated list of the user's SSH public keys.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "ssh_account_key";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          owner?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "ssh_account_key";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        owner?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A list of the SSH keys associated with the account.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "ssh_account_key";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      owner?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "ssh_account_key";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    owner?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "ssh_account_key";
              } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  owner?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user's keys are not accessible to the current user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          selected_user: string;
      }
      • Readonlyselected_user: string

        This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Add a new SSH key

    Adds a new SSH public key to the specified user account and returns the resulting key.

    Example:
    
    ```
    $ curl -X POST -H "Content-Type: application/json" -d '{"key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY user@myhost"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
        }
        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "ssh_account_key";
              } & Omit<{
                  type: "ssh_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  comment?: string;
                  created_on?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: ...;
                  };
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          };
      }

      The new SSH key object. Note that the username property has been deprecated due to privacy changes.

      • Readonlycontent: {
            application/json: {
                type: "ssh_account_key";
            } & Omit<{
                type: "ssh_key";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                comment?: string;
                created_on?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: ...;
                };
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "ssh_account_key";
          } & Omit<{
              type: "ssh_key";
          } & Omit<Readonly<(...)> & {
              type: ...;
          }, "type"> & Readonly<Record<string, unknown>> & {
              comment?: string;
              created_on?: string;
              key?: string;
              label?: string;
              last_used?: string;
              links?: {
                  self?: ...;
              };
              uuid?: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              owner?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "ssh_account_key";
                  } & Omit<{
                      type: "ssh_key";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      comment?: string;
                      created_on?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: ...;
                      };
                      uuid?: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly created SSH key.

        • content: {
              application/json: {
                  type: "ssh_account_key";
              } & Omit<{
                  type: "ssh_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  comment?: string;
                  created_on?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: ...;
                  };
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "ssh_account_key";
            } & Omit<{
                type: "ssh_key";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                comment?: string;
                created_on?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: ...;
                };
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the submitted key or related value is invalid

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to add a key for the specified user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/users/{selected_user}/ssh-keys/{key_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            selected_user: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a SSH key

    Deletes a specific SSH public key from a user's account.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            selected_user: string;
        }
        • Readonlykey_id: string

          The SSH key's UUID value.

        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The key has been deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the submitted key or related value is invalid

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to add a key for the specified user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a SSH key

    Returns a specific SSH public key belonging to a user.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            selected_user: string;
        }
        • Readonlykey_id: string

          The SSH key's UUID value.

        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "ssh_account_key";
                  } & Omit<{
                      type: "ssh_key";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      comment?: string;
                      created_on?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: ...;
                      };
                      uuid?: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specific SSH key matching the user and UUID

        • content: {
              application/json: {
                  type: "ssh_account_key";
              } & Omit<{
                  type: "ssh_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  comment?: string;
                  created_on?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: ...;
                  };
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "ssh_account_key";
            } & Omit<{
                type: "ssh_key";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                comment?: string;
                created_on?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: ...;
                };
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or key is not accessible to the current user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user or key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            selected_user: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          key_id: string;
          selected_user: string;
      }
      • Readonlykey_id: string

        The SSH key's UUID value.

      • Readonlyselected_user: string

        This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                selected_user: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "ssh_account_key";
                    } & Omit<{
                        type: "ssh_key";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        comment?: string;
                        created_on?: string;
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: ...;
                        };
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        owner?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a SSH key

    Updates a specific SSH public key on a user's account

    Note: Only the 'comment' field can be updated using this API. To modify the key or comment values, you must delete and add the key again.
    
    Example:
    
    ```
    $ curl -X PUT -H "Content-Type: application/json" -d '{"label": "Work key"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              selected_user: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            selected_user: string;
        }
        • Readonlykey_id: string

          The SSH key's UUID value.

        • Readonlyselected_user: string

          This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "ssh_account_key";
              } & Omit<{
                  type: "ssh_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  comment?: string;
                  created_on?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: ...;
                  };
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          };
      }

      The updated SSH key object

      • Readonlycontent: {
            application/json: {
                type: "ssh_account_key";
            } & Omit<{
                type: "ssh_key";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                comment?: string;
                created_on?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: ...;
                };
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            };
        }
        • Readonlyapplication/json: {
              type: "ssh_account_key";
          } & Omit<{
              type: "ssh_key";
          } & Omit<Readonly<(...)> & {
              type: ...;
          }, "type"> & Readonly<Record<string, unknown>> & {
              comment?: string;
              created_on?: string;
              key?: string;
              label?: string;
              last_used?: string;
              links?: {
                  self?: ...;
              };
              uuid?: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              owner?: {
                  type: "account";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  display_name?: (...) | (...);
                  links?: (...) | (...);
                  uuid?: (...) | (...);
              };
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "ssh_account_key";
                  } & Omit<{
                      type: "ssh_key";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      comment?: string;
                      created_on?: string;
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: ...;
                      };
                      uuid?: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      owner?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "ssh_account_key";
                } & Omit<{
                    type: "ssh_key";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    comment?: string;
                    created_on?: string;
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: ...;
                    };
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    owner?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The newly updated SSH key.

        • content: {
              application/json: {
                  type: "ssh_account_key";
              } & Omit<{
                  type: "ssh_key";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  comment?: string;
                  created_on?: string;
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: ...;
                  };
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  owner?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "ssh_account_key";
            } & Omit<{
                type: "ssh_key";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                comment?: string;
                created_on?: string;
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: ...;
                };
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                owner?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the submitted key or related value is invalid

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to add a key for the specified user

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                role?: "member" | "owner" | "collaborator";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            is_privacy_enforced?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                q?: string;
                role?: "member" | "owner" | "collaborator";
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            is_privacy_enforced?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List workspaces for user

    Returns a list of workspaces accessible by the authenticated user.

    Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by
    workspace or permission by adding the following query string parameters:
    
    * `q=slug="bbworkspace1"` or `q=is_private=true`
    * `sort=created_on`
    
    Note that the query parameter values need to be URL escaped so that `=`
    would become `%3D`.
    
    **The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,
    see the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              q?: string;
              role?: "member" | "owner" | "collaborator";
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Optional Readonlypath?: undefined
      • Optional Readonlyquery?: {
            q?: string;
            role?: "member" | "owner" | "collaborator";
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response. See filtering and sorting for details.

        • Optional Readonlyrole?: "member" | "owner" | "collaborator"

          Filters the workspaces based on the authenticated user's role on each workspace.

                      * **member**: returns a list of all the workspaces which the caller is a member of
                          at least one workspace group or repository
                      * **collaborator**: returns a list of workspaces which the caller has write access
                          to at least one repository in the workspace
                      * **owner**: returns a list of workspaces which the caller has administrator access
          
        • Optional Readonlysort?: string

          Name of a response property to sort results. See filtering and sorting for details.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "workspace";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          is_privacy_enforced?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          slug?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "workspace";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        is_privacy_enforced?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        slug?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of workspaces accessible by the authenticated user.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "workspace";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      is_privacy_enforced?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      slug?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "workspace";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    is_privacy_enforced?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    slug?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "workspace";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  is_privacy_enforced?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  slug?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "workspace";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        is_privacy_enforced?: boolean;
                        is_private?: boolean;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            members?: {
                                href?: ...;
                                name?: ...;
                            };
                            owners?: {
                                href?: ...;
                                name?: ...;
                            };
                            projects?: {
                                href?: ...;
                                name?: ...;
                            };
                            repositories?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            snippets?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        slug?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "workspace";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        is_privacy_enforced?: boolean;
                        is_private?: boolean;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                            members?: {
                                href?: ...;
                                name?: ...;
                            };
                            owners?: {
                                href?: ...;
                                name?: ...;
                            };
                            projects?: {
                                href?: ...;
                                name?: ...;
                            };
                            repositories?: {
                                href?: ...;
                                name?: ...;
                            };
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                            snippets?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        slug?: string;
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a workspace

    Returns the requested workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "workspace";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      is_privacy_enforced?: boolean;
                      is_private?: boolean;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                          members?: {
                              href?: ...;
                              name?: ...;
                          };
                          owners?: {
                              href?: ...;
                              name?: ...;
                          };
                          projects?: {
                              href?: ...;
                              name?: ...;
                          };
                          repositories?: {
                              href?: ...;
                              name?: ...;
                          };
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                          snippets?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      slug?: string;
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "workspace";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    is_privacy_enforced?: boolean;
                    is_private?: boolean;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                        members?: {
                            href?: ...;
                            name?: ...;
                        };
                        owners?: {
                            href?: ...;
                            name?: ...;
                        };
                        projects?: {
                            href?: ...;
                            name?: ...;
                        };
                        repositories?: {
                            href?: ...;
                            name?: ...;
                        };
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                        snippets?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    slug?: string;
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace.

        • content: {
              application/json: {
                  type: "workspace";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  is_privacy_enforced?: boolean;
                  is_private?: boolean;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                      members?: {
                          href?: ...;
                          name?: ...;
                      };
                      owners?: {
                          href?: ...;
                          name?: ...;
                      };
                      projects?: {
                          href?: ...;
                          name?: ...;
                      };
                      repositories?: {
                          href?: ...;
                          name?: ...;
                      };
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                      snippets?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  slug?: string;
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "workspace";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                is_privacy_enforced?: boolean;
                is_private?: boolean;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                    members?: {
                        href?: ...;
                        name?: ...;
                    };
                    owners?: {
                        href?: ...;
                        name?: ...;
                    };
                    projects?: {
                        href?: ...;
                        name?: ...;
                    };
                    repositories?: {
                        href?: ...;
                        name?: ...;
                    };
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                    snippets?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                slug?: string;
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If no workspace exists for the specified name or UUID.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/hooks: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "webhook_subscription";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            active?: (...) | (...) | (...);
                            created_at?: (...) | (...);
                            description?: (...) | (...);
                            events?: (...) | (...);
                            secret?: (...) | (...);
                            secret_set?: (...) | (...) | (...);
                            subject?: (...) | (...);
                            subject_type?: (...) | (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "webhook_subscription";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            active?: (...) | (...) | (...);
                            created_at?: (...) | (...);
                            description?: (...) | (...);
                            events?: (...) | (...);
                            secret?: (...) | (...);
                            secret_set?: (...) | (...) | (...);
                            subject?: (...) | (...);
                            subject_type?: (...) | (...) | (...);
                            url?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List webhooks for a workspace

    Returns a paginated list of webhooks installed on this workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "webhook_subscription";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          active?: (...) | (...) | (...);
                          created_at?: (...) | (...);
                          description?: (...) | (...);
                          events?: (...) | (...);
                          secret?: (...) | (...);
                          secret_set?: (...) | (...) | (...);
                          subject?: (...) | (...);
                          subject_type?: (...) | (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "webhook_subscription";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        active?: (...) | (...) | (...);
                        created_at?: (...) | (...);
                        description?: (...) | (...);
                        events?: (...) | (...);
                        secret?: (...) | (...);
                        secret_set?: (...) | (...) | (...);
                        subject?: (...) | (...);
                        subject_type?: (...) | (...) | (...);
                        url?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The paginated list of installed webhooks.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "webhook_subscription";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      active?: (...) | (...) | (...);
                      created_at?: (...) | (...);
                      description?: (...) | (...);
                      events?: (...) | (...);
                      secret?: (...) | (...);
                      secret_set?: (...) | (...) | (...);
                      subject?: (...) | (...);
                      subject_type?: (...) | (...) | (...);
                      url?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "webhook_subscription";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    active?: (...) | (...) | (...);
                    created_at?: (...) | (...);
                    description?: (...) | (...);
                    events?: (...) | (...);
                    secret?: (...) | (...);
                    secret_set?: (...) | (...) | (...);
                    subject?: (...) | (...);
                    subject_type?: (...) | (...) | (...);
                    url?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "webhook_subscription";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  active?: (...) | (...) | (...);
                  created_at?: (...) | (...);
                  description?: (...) | (...);
                  events?: (...) | (...);
                  secret?: (...) | (...);
                  secret_set?: (...) | (...) | (...);
                  subject?: (...) | (...);
                  subject_type?: (...) | (...) | (...);
                  url?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user is not an owner on the specified workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a webhook for a workspace

    Creates a new webhook on the specified workspace.

    Workspace webhooks are fired for events from all repositories contained
    by that workspace.
    
    Example:
    
    ```
    $ curl -X POST -u credentials -H 'Content-Type: application/json'
      https://api.bitbucket.org/2.0/workspaces/my-workspace/hooks
      -d '
        {
          "description": "Webhook Description",
          "url": "https://example.com/",
          "active": true,
          "secret": "this is a really bad secret",
          "events": [
            "repo:push",
            "issue:created",
            "issue:updated"
          ]
        }'
    ```
    
    When the `secret` is provided it will be used as the key to generate a HMAC
    digest value sent in the `X-Hub-Signature` header at delivery time. Passing
    a `null` or empty `secret` or not passing a `secret` will leave the webhook's
    secret unset. Bitbucket only generates the `X-Hub-Signature` when the webhook's
    secret is set.
    
    This call requires the webhook scope, as well as any scope
    that applies to the events that the webhook subscribes to. In the
    example above that means: `webhook`, `repository` and `issue`.
    
    The `url` must properly resolve and cannot be an internal, non-routed address.
    
    Only workspace owners can install webhooks on workspaces.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        If the webhook was registered successfully.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of new newly created webhook.

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to install webhooks on the specified workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/hooks/{uid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            uid: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a webhook for a workspace

    Deletes the specified webhook subscription from the given workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            uid: string;
            workspace: string;
        }
        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        When the webhook was deleted successfully

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to delete the webhook.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a webhook for a workspace

    Returns the webhook with the specified id installed on the given workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            uid: string;
            workspace: string;
        }
        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The webhook subscription object.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            uid: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          uid: string;
          workspace: string;
      }
      • Readonlyuid: string

        Installed webhook's ID

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                uid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "webhook_subscription";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        active?: boolean;
                        created_at?: string;
                        description?: string;
                        events?: readonly (
                            | "issue:comment_created"
                            | "issue:created"
                            | "issue:updated"
                            | "project:updated"
                            | "pullrequest:approved"
                            | "pullrequest:changes_request_created"
                            | "pullrequest:changes_request_removed"
                            | "pullrequest:comment_created"
                            | "pullrequest:comment_deleted"
                            | "pullrequest:comment_reopened"
                            | "pullrequest:comment_resolved"
                            | "pullrequest:comment_updated"
                            | "pullrequest:created"
                            | "pullrequest:fulfilled"
                            | "pullrequest:push"
                            | "pullrequest:rejected"
                            | "pullrequest:unapproved"
                            | "pullrequest:updated"
                            | "repo:commit_comment_created"
                            | "repo:commit_status_created"
                            | "repo:commit_status_updated"
                            | "repo:created"
                            | "repo:deleted"
                            | "repo:fork"
                            | "repo:imported"
                            | "repo:push"
                            | "repo:transfer"
                            | "repo:updated")[];
                        secret?: string;
                        secret_set?: boolean;
                        subject?: Readonly<Record<(...), (...)>> & {
                            type: string;
                        };
                        subject_type?: "repository" | "workspace";
                        url?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a webhook for a workspace

    Updates the specified webhook subscription.

    The following properties can be mutated:
    
    * `description`
    * `url`
    * `secret`
    * `active`
    * `events`
    
    The hook's secret is used as a key to generate the HMAC hex digest sent in the
    `X-Hub-Signature` header at delivery time. This signature is only generated
    when the hook has a secret.
    
    Set the hook's secret by passing the new value in the `secret` field. Passing a
    `null` value in the `secret` field will remove the secret from the hook. The
    hook's secret can be left unchanged by not passing the `secret` field in the
    request.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              uid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            uid: string;
            workspace: string;
        }
        • Readonlyuid: string

          Installed webhook's ID

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "webhook_subscription";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      active?: boolean;
                      created_at?: string;
                      description?: string;
                      events?: readonly (
                          | "issue:comment_created"
                          | "issue:created"
                          | "issue:updated"
                          | "project:updated"
                          | "pullrequest:approved"
                          | "pullrequest:changes_request_created"
                          | "pullrequest:changes_request_removed"
                          | "pullrequest:comment_created"
                          | "pullrequest:comment_deleted"
                          | "pullrequest:comment_reopened"
                          | "pullrequest:comment_resolved"
                          | "pullrequest:comment_updated"
                          | "pullrequest:created"
                          | "pullrequest:fulfilled"
                          | "pullrequest:push"
                          | "pullrequest:rejected"
                          | "pullrequest:unapproved"
                          | "pullrequest:updated"
                          | "repo:commit_comment_created"
                          | "repo:commit_status_created"
                          | "repo:commit_status_updated"
                          | "repo:created"
                          | "repo:deleted"
                          | "repo:fork"
                          | "repo:imported"
                          | "repo:push"
                          | "repo:transfer"
                          | "repo:updated")[];
                      secret?: string;
                      secret_set?: boolean;
                      subject?: Readonly<Record<(...), (...)>> & {
                          type: string;
                      };
                      subject_type?: "repository" | "workspace";
                      url?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "webhook_subscription";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    active?: boolean;
                    created_at?: string;
                    description?: string;
                    events?: readonly (
                        | "issue:comment_created"
                        | "issue:created"
                        | "issue:updated"
                        | "project:updated"
                        | "pullrequest:approved"
                        | "pullrequest:changes_request_created"
                        | "pullrequest:changes_request_removed"
                        | "pullrequest:comment_created"
                        | "pullrequest:comment_deleted"
                        | "pullrequest:comment_reopened"
                        | "pullrequest:comment_resolved"
                        | "pullrequest:comment_updated"
                        | "pullrequest:created"
                        | "pullrequest:fulfilled"
                        | "pullrequest:push"
                        | "pullrequest:rejected"
                        | "pullrequest:unapproved"
                        | "pullrequest:updated"
                        | "repo:commit_comment_created"
                        | "repo:commit_status_created"
                        | "repo:commit_status_updated"
                        | "repo:created"
                        | "repo:deleted"
                        | "repo:fork"
                        | "repo:imported"
                        | "repo:push"
                        | "repo:transfer"
                        | "repo:updated")[];
                    secret?: string;
                    secret_set?: boolean;
                    subject?: Readonly<Record<(...), (...)>> & {
                        type: string;
                    };
                    subject_type?: "repository" | "workspace";
                    url?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The webhook subscription object.

        • content: {
              application/json: {
                  type: "webhook_subscription";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  active?: boolean;
                  created_at?: string;
                  description?: string;
                  events?: readonly (
                      | "issue:comment_created"
                      | "issue:created"
                      | "issue:updated"
                      | "project:updated"
                      | "pullrequest:approved"
                      | "pullrequest:changes_request_created"
                      | "pullrequest:changes_request_removed"
                      | "pullrequest:comment_created"
                      | "pullrequest:comment_deleted"
                      | "pullrequest:comment_reopened"
                      | "pullrequest:comment_resolved"
                      | "pullrequest:comment_updated"
                      | "pullrequest:created"
                      | "pullrequest:fulfilled"
                      | "pullrequest:push"
                      | "pullrequest:rejected"
                      | "pullrequest:unapproved"
                      | "pullrequest:updated"
                      | "repo:commit_comment_created"
                      | "repo:commit_status_created"
                      | "repo:commit_status_updated"
                      | "repo:created"
                      | "repo:deleted"
                      | "repo:fork"
                      | "repo:imported"
                      | "repo:push"
                      | "repo:transfer"
                      | "repo:updated")[];
                  secret?: string;
                  secret_set?: boolean;
                  subject?: Readonly<Record<(...), (...)>> & {
                      type: string;
                  };
                  subject_type?: "repository" | "workspace";
                  url?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "webhook_subscription";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                active?: boolean;
                created_at?: string;
                description?: string;
                events?: readonly (
                    | "issue:comment_created"
                    | "issue:created"
                    | "issue:updated"
                    | "project:updated"
                    | "pullrequest:approved"
                    | "pullrequest:changes_request_created"
                    | "pullrequest:changes_request_removed"
                    | "pullrequest:comment_created"
                    | "pullrequest:comment_deleted"
                    | "pullrequest:comment_reopened"
                    | "pullrequest:comment_resolved"
                    | "pullrequest:comment_updated"
                    | "pullrequest:created"
                    | "pullrequest:fulfilled"
                    | "pullrequest:push"
                    | "pullrequest:rejected"
                    | "pullrequest:unapproved"
                    | "pullrequest:updated"
                    | "repo:commit_comment_created"
                    | "repo:commit_status_created"
                    | "repo:commit_status_updated"
                    | "repo:created"
                    | "repo:deleted"
                    | "repo:fork"
                    | "repo:imported"
                    | "repo:push"
                    | "repo:transfer"
                    | "repo:updated")[];
                secret?: string;
                secret_set?: boolean;
                subject?: Readonly<Record<(...), (...)>> & {
                    type: string;
                };
                subject_type?: "repository" | "workspace";
                url?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have permission to update the webhook.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the webhook or workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/members: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List users in a workspace

    Returns all members of the requested workspace.

    This endpoint additionally supports [filtering](/cloud/bitbucket/rest/intro/#filtering) by
    email address, if called by a workspace administrator, integration or workspace access
    token. This is done by adding the following query string parameter:
    
    * `q=user.email IN ("user1@org.com","user2@org.com")`
    
    When filtering by email, you can query up to 90 addresses at a time.
    Note that the query parameter values need to be URL escaped, so the final query string
    should be:
    
    * `q=user.email%20IN%20(%22user1@org.com%22,%22user2@org.com%22)`
    
    Email addresses that you filter by (and only these email addresses) can be included in the
    response using the `fields` query parameter:
    
    * `&fields=+values.user.email` - add the `email` field to the default `user` response object
    * `&fields=values.user.email,values.user.account_id` - only return user email addresses and
    account IDs
    
    Once again, all query parameter values must be URL escaped.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "workspace_membership";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          user?: (...) | (...);
                          workspace?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "workspace_membership";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        user?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of users that are part of a workspace.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "workspace_membership";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      user?: (...) | (...);
                      workspace?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "workspace_membership";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    user?: (...) | (...);
                    workspace?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "workspace_membership";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  user?: (...) | (...);
                  workspace?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        When more than 90 emails were provided when querying by email.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/members/{member}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                member: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "workspace_membership";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        workspace?: {
                            type: "workspace";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            is_privacy_enforced?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            member: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                member: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "workspace_membership";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        user?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        workspace?: {
                            type: "workspace";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            is_privacy_enforced?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get user membership for a workspace

    Returns the workspace membership, which includes a User object for the member and a Workspace object for the requested workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              member: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            member: string;
            workspace: string;
        }
        • Readonlymember: string

          Member's UUID or Atlassian ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "workspace_membership";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      user?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      workspace?: {
                          type: "workspace";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          is_privacy_enforced?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          slug?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "workspace_membership";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    user?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    workspace?: {
                        type: "workspace";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        is_privacy_enforced?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        slug?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user that is part of a workspace.

        • content: {
              application/json: {
                  type: "workspace_membership";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  user?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  workspace?: {
                      type: "workspace";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      is_privacy_enforced?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      slug?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "workspace_membership";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                user?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                workspace?: {
                    type: "workspace";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    is_privacy_enforced?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    slug?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A workspace cannot be found, or a user cannot be found, or the user is not a a member of the workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            member: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          member: string;
          workspace: string;
      }
      • Readonlymember: string

        Member's UUID or Atlassian ID.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/permissions: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "workspace_membership";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            user?: (...) | (...);
                            workspace?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List user permissions in a workspace

    Returns the list of members in a workspace and their permission levels. Permission can be: * owner * collaborator * member

    **The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,
    see the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**
    
    **When you move your administration from Bitbucket Cloud to admin.atlassian.com, the following fields on
    `workspace_membership` will no longer be present: `last_accessed` and `added_on`. See the
    [deprecation announcement](/cloud/bitbucket/announcement-breaking-change-workspace-membership/).**
    
    Results may be further [filtered](/cloud/bitbucket/rest/intro/#filtering) by
    permission by adding the following query string parameters:
    
    * `q=permission="owner"`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: {
              q?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "workspace_membership";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          user?: (...) | (...);
                          workspace?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "workspace_membership";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        user?: (...) | (...);
                        workspace?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of users that are part of a workspace, along with their permission.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "workspace_membership";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      user?: (...) | (...);
                      workspace?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "workspace_membership";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    user?: (...) | (...);
                    workspace?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "workspace_membership";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  user?: (...) | (...);
                  workspace?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/permissions/repositories: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List all repository permissions for a workspace

    Returns an object for each repository permission for all of a workspace's repositories.

    Permissions returned are effective permissions: the highest level of
    permission the user has. This does not distinguish between direct and
    indirect (group) privileges.
    
    Only users with admin permission for the team may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    
    Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering)
    by repository, user, or permission by adding the following query string
    parameters:
    
    * `q=repository.name="geordi"` or `q=permission>"read"`
    * `sort=user.display_name`
    
    Note that the query parameter values need to be URL escaped so that `=`
    would become `%3D`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Name of a response property sort the result by as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          repository?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        repository?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        List of workspace's repository permissions.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      repository?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    repository?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  repository?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the workspace.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/permissions/repositories/{repo_slug}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                repo_slug: string;
                workspace: string;
            };
            query?: {
                q?: string;
                sort?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            repository?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List a repository permissions for a workspace

    Returns an object for the repository permission of each user in the requested repository.

    Permissions returned are effective permissions: the highest level of
    permission the user has. This does not distinguish between direct and
    indirect (group) privileges.
    
    Only users with admin permission for the repository may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `write`
    * `read`
    
    Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering)
    by user, or permission by adding the following query string parameters:
    
    * `q=permission>"read"`
    * `sort=user.display_name`
    
    Note that the query parameter values need to be URL escaped so that `=`
    would become `%3D`.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              repo_slug: string;
              workspace: string;
          };
          query?: {
              q?: string;
              sort?: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            repo_slug: string;
            workspace: string;
        }
        • Readonlyrepo_slug: string

          This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            q?: string;
            sort?: string;
        }
        • Optional Readonlyq?: string

          Query string to narrow down the response as per filtering and sorting.

        • Optional Readonlysort?: string

          Name of a response property sort the result by as per filtering and sorting.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          repository?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        repository?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The repository permission for all users in this repository.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      repository?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    repository?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  repository?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the repository.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            repo_slug: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          repo_slug: string;
          workspace: string;
      }
      • Readonlyrepo_slug: string

        This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get OpenID configuration for OIDC in Pipelines

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The OpenID configuration

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/pipelines-config/identity/oidc/keys.json: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get keys for OIDC in Pipelines

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The keys in JSON web key format

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/pipelines-config/variables: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pipeline_variable";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            key?: (...) | (...);
                            secured?: (...) | (...) | (...);
                            uuid?: (...) | (...);
                            value?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List variables for a workspace

    Find workspace level variables.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pipeline_variable";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          key?: (...) | (...);
                          secured?: (...) | (...) | (...);
                          uuid?: (...) | (...);
                          value?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pipeline_variable";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        key?: (...) | (...);
                        secured?: (...) | (...) | (...);
                        uuid?: (...) | (...);
                        value?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The found workspace level variables.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pipeline_variable";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      key?: (...) | (...);
                      secured?: (...) | (...) | (...);
                      uuid?: (...) | (...);
                      value?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pipeline_variable";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    key?: (...) | (...);
                    secured?: (...) | (...) | (...);
                    uuid?: (...) | (...);
                    value?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pipeline_variable";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  key?: (...) | (...);
                  secured?: (...) | (...) | (...);
                  uuid?: (...) | (...);
                  value?: (...) | (...);
              })[]

              The values of the current page.

        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            409: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a variable for a workspace

    Create a workspace level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          409: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The created variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The URL of the newly created pipeline variable.

      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly409: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A variable with the provided key already exists.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a variable for a workspace

    Delete a workspace level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyvariable_uuid: string

          The UUID of the variable to delete.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace or the variable with the provided UUID does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get variable for a workspace

    Retrieve a workspace level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyvariable_uuid: string

          The UUID of the variable to retrieve.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace or variable with the given UUID was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                variable_uuid: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "pipeline_variable";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        key?: string;
                        secured?: boolean;
                        uuid?: string;
                        value?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update variable for a workspace

    Update a workspace level variable.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              variable_uuid: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            variable_uuid: string;
            workspace: string;
        }
        • Readonlyvariable_uuid: string

          The UUID of the variable.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "pipeline_variable";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              key?: string;
              secured?: boolean;
              uuid?: string;
              value?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "pipeline_variable";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      key?: string;
                      secured?: boolean;
                      uuid?: string;
                      value?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "pipeline_variable";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    key?: string;
                    secured?: boolean;
                    uuid?: string;
                    value?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The variable was updated.

        • content: {
              application/json: {
                  type: "pipeline_variable";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  key?: string;
                  secured?: boolean;
                  uuid?: string;
                  value?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "pipeline_variable";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                key?: string;
                secured?: boolean;
                uuid?: string;
                value?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The workspace or the variable was not found.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: (...) & (...) & (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List projects in a workspace

    Returns the list of projects in this workspace.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of projects in this workspace.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "project";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  created_on?: (...) | (...);
                  description?: (...) | (...);
                  has_publicly_visible_repos?: (...) | (...) | (...);
                  is_private?: (...) | (...) | (...);
                  key?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  owner?: (...) | (...);
                  updated_on?: (...) | (...);
                  uuid?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A workspace doesn't exist at this location.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          workspace: string;
      }
      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: (...) & (...) & (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            201: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a project in a workspace

    Creates a new project.

    Note that the avatar has to be embedded as either a data-url
    or a URL to an external image as shown in the examples below:
    
    ```
    $ body=$(cat << EOF
    {
        "name": "Mars Project",
        "key": "MARS",
        "description": "Software for colonizing mars.",
        "links": {
            "avatar": {
                "href": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/..."
            }
        },
        "is_private": false
    }
    EOF
    )
    $ curl -H "Content-Type: application/json" \
           -X POST \
           -d "$body" \
           https://api.bitbucket.org/2.0/workspaces/teams-in-space/projects/ | jq .
    {
      // Serialized project document
    }
    ```
    
    or even:
    
    ```
    $ body=$(cat << EOF
    {
        "name": "Mars Project",
        "key": "MARS",
        "description": "Software for colonizing mars.",
        "links": {
            "avatar": {
                "href": "http://i.imgur.com/72tRx4w.gif"
            }
        },
        "is_private": false
    }
    EOF
    )
    $ curl -H "Content-Type: application/json" \
           -X POST \
           -d "$body" \
           https://api.bitbucket.org/2.0/workspaces/teams-in-space/projects/ | jq .
    {
      // Serialized project document
    }
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<{
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: (...) & (...) & (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<{
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: (...) & (...) & (...);
                };
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "project";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              has_publicly_visible_repos?: boolean;
              is_private?: boolean;
              key?: string;
              links?: {
                  avatar?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              name?: string;
              owner?: {
                  type: "team";
              } & Omit<{
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: (...) & (...) & (...);
              };
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          201: {
              content: {
                  application/json: {
                      type: "project";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      has_publicly_visible_repos?: boolean;
                      is_private?: boolean;
                      key?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      owner?: {
                          type: "team";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly201: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        A new project has been created.

        • content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly created project

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user requesting to create a project does not have the necessary permissions.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A workspace doesn't exist at this location.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: (...) & (...) & (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            201: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a project for a workspace

    Deletes this project. This is an irreversible operation.

    You cannot delete a project that still contains repositories.
    To delete the project, [delete](/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-delete)
    or transfer the repositories first.
    
    Example:
    ```
    $ curl -X DELETE https://api.bitbucket.org/2.0/workspaces/bbworkspace1/projects/PROJ
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        Successful deletion.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't authorized to delete the project or the project isn't empty.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A project isn't hosted at this location.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a project for a workspace

    Returns the requested project.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "project";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      has_publicly_visible_repos?: boolean;
                      is_private?: boolean;
                      key?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      owner?: {
                          type: "team";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The project that is part of a workspace.

        • content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The request wasn't authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't authorized to access the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A project isn't hosted at this location.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                        html?: {
                            href?: (...) | (...);
                            name?: (...) | (...);
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<{
                        type: ...;
                    } & Omit<(...), (...)> & Readonly<(...)> & {
                        created_on?: ...;
                        display_name?: ...;
                        links?: ...;
                        uuid?: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        links?: (...) & (...) & (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            201: {
                content: {
                    application/json: {
                        type: "project";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        description?: string;
                        has_publicly_visible_repos?: boolean;
                        is_private?: boolean;
                        key?: string;
                        links?: {
                            avatar?: {
                                href?: ...;
                                name?: ...;
                            };
                            html?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        name?: string;
                        owner?: {
                            type: "team";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                        };
                        updated_on?: string;
                        uuid?: string;
                    };
                };
                headers: {
                    Location?: string;
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update a project for a workspace

    Since this endpoint can be used to both update and to create a project, the request body depends on the intent.

    #### Creation
    
    See the POST documentation for the project collection for an
    example of the request body.
    
    Note: The `key` should not be specified in the body of request
    (since it is already present in the URL). The `name` is required,
    everything else is optional.
    
    #### Update
    
    See the POST documentation for the project collection for an
    example of the request body.
    
    Note: The key is not required in the body (since it is already in
    the URL). The key may be specified in the body, if the intent is
    to change the key itself. In such a scenario, the location of the
    project is changed and is returned in the `Location` header of the
    response.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                      html?: {
                          href?: (...) | (...);
                          name?: (...) | (...);
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<{
                      type: ...;
                  } & Omit<(...), (...)> & Readonly<(...)> & {
                      created_on?: ...;
                      display_name?: ...;
                      links?: ...;
                      uuid?: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      links?: (...) & (...) & (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                    html?: {
                        href?: (...) | (...);
                        name?: (...) | (...);
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<{
                    type: ...;
                } & Omit<(...), (...)> & Readonly<(...)> & {
                    created_on?: ...;
                    display_name?: ...;
                    links?: ...;
                    uuid?: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    links?: (...) & (...) & (...);
                };
                updated_on?: string;
                uuid?: string;
            };
        }
        • Readonlyapplication/json: {
              type: "project";
          } & Omit<Readonly<Record<string, unknown>> & {
              type: string;
          }, "type"> & Readonly<Record<string, unknown>> & {
              created_on?: string;
              description?: string;
              has_publicly_visible_repos?: boolean;
              is_private?: boolean;
              key?: string;
              links?: {
                  avatar?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
                  html?: {
                      href?: (...) | (...);
                      name?: (...) | (...);
                  };
              };
              name?: string;
              owner?: {
                  type: "team";
              } & Omit<{
                  type: ...;
              } & Omit<(...), (...)> & Readonly<(...)> & {
                  created_on?: ...;
                  display_name?: ...;
                  links?: ...;
                  uuid?: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  links?: (...) & (...) & (...);
              };
              updated_on?: string;
              uuid?: string;
          }
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "project";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      has_publicly_visible_repos?: boolean;
                      is_private?: boolean;
                      key?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      owner?: {
                          type: "team";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          201: {
              content: {
                  application/json: {
                      type: "project";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      description?: string;
                      has_publicly_visible_repos?: boolean;
                      is_private?: boolean;
                      key?: string;
                      links?: {
                          avatar?: {
                              href?: ...;
                              name?: ...;
                          };
                          html?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      name?: string;
                      owner?: {
                          type: "team";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                      };
                      updated_on?: string;
                      uuid?: string;
                  };
              };
              headers: {
                  Location?: string;
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        The existing project is has been updated.

        • content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the project. This header is only provided when the project key is updated.

      • Readonly201: {
            content: {
                application/json: {
                    type: "project";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    description?: string;
                    has_publicly_visible_repos?: boolean;
                    is_private?: boolean;
                    key?: string;
                    links?: {
                        avatar?: {
                            href?: ...;
                            name?: ...;
                        };
                        html?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    name?: string;
                    owner?: {
                        type: "team";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                    };
                    updated_on?: string;
                    uuid?: string;
                };
            };
            headers: {
                Location?: string;
                [name: string]: unknown;
            };
        }

        A new project has been created.

        • content: {
              application/json: {
                  type: "project";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  description?: string;
                  has_publicly_visible_repos?: boolean;
                  is_private?: boolean;
                  key?: string;
                  links?: {
                      avatar?: {
                          href?: ...;
                          name?: ...;
                      };
                      html?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  name?: string;
                  owner?: {
                      type: "team";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                  };
                  updated_on?: string;
                  uuid?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "project";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                description?: string;
                has_publicly_visible_repos?: boolean;
                is_private?: boolean;
                key?: string;
                links?: {
                    avatar?: {
                        href?: ...;
                        name?: ...;
                    };
                    html?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                name?: string;
                owner?: {
                    type: "team";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                };
                updated_on?: string;
                uuid?: string;
            }
        • headers: {
              Location?: string;
              [name: string]: unknown;
          }
          • [name: string]: unknown
          • Optional ReadonlyLocation?: string

            The location of the newly created project

      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't authorized to update or create the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        A workspace doesn't exist at the location. Note that the project's absence from this location doesn't raise a 404, since a PUT at a non-existent location can be used to create a new project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/branching-model: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_branching_model";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix: string;
                        }[];
                        development?: {
                            name: string;
                            use_mainbranch: boolean;
                        };
                        production?: {
                            name: string;
                            use_mainbranch: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the branching model for a project

    Return the branching model set at the project level. This view is read-only. The branching model settings can be changed using the settings API.

    The returned object:
    
    1. Always has a `development` property. `development.name` is
       the user-specified branch that can be inherited by an individual repository's
       branching model.
    2. Might have a `production` property. `production` will not
       be present when `production` is disabled.
       `production.name` is the user-specified branch that can be
       inherited by an individual repository's branching model.
    3. Always has a `branch_types` array which contains all enabled branch
       types.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "project_branching_model";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix: string;
                      }[];
                      development?: {
                          name: string;
                          use_mainbranch: boolean;
                      };
                      production?: {
                          name: string;
                          use_mainbranch: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "project_branching_model";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix: string;
                    }[];
                    development?: {
                        name: string;
                        use_mainbranch: boolean;
                    };
                    production?: {
                        name: string;
                        use_mainbranch: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branching model object

        • content: {
              application/json: {
                  type: "project_branching_model";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix: string;
                  }[];
                  development?: {
                      name: string;
                      use_mainbranch: boolean;
                  };
                  production?: {
                      name: string;
                      use_mainbranch: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "project_branching_model";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix: string;
                }[];
                development?: {
                    name: string;
                    use_mainbranch: boolean;
                };
                production?: {
                    name: string;
                    use_mainbranch: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have read access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/branching-model/settings: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get the branching model config for a project

    Return the branching model configuration for a project. The returned object:

    1. Always has a `development` property for the development branch.
    2. Always a `production` property for the production branch. The
       production branch can be disabled.
    3. The `branch_types` contains all the branch types.
    
    
    This is the raw configuration for the branching model. A client
    wishing to see the branching model with its actual current branches may find the
    [active model API](#api-workspaces-workspace-projects-project-key-branching-model-get)
    more useful.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branching_model_settings";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          enabled?: (...) | (...) | (...);
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix?: (...) | (...);
                      }[];
                      development?: {
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      production?: {
                          enabled?: boolean;
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branching_model_settings";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        enabled?: (...) | (...) | (...);
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix?: (...) | (...);
                    }[];
                    development?: {
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    production?: {
                        enabled?: boolean;
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The branching model configuration

        • content: {
              application/json: {
                  type: "branching_model_settings";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      enabled?: (...) | (...) | (...);
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix?: (...) | (...);
                  }[];
                  development?: {
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  production?: {
                      enabled?: boolean;
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "branching_model_settings";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    enabled?: (...) | (...) | (...);
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix?: (...) | (...);
                }[];
                development?: {
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                production?: {
                    enabled?: boolean;
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "branching_model_settings";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        branch_types?: readonly {
                            enabled?: (...) | (...) | (...);
                            kind:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            prefix?: (...) | (...);
                        }[];
                        development?: {
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        production?: {
                            enabled?: boolean;
                            is_valid?: boolean;
                            name?: string;
                            use_mainbranch?: boolean;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update the branching model config for a project

    Update the branching model configuration for a project.

    The `development` branch can be configured to a specific branch or to
    track the main branch. Any branch name can be supplied, but will only
    successfully be applied to a repository via inheritance if that branch
    exists for that repository. Only the passed properties will be updated. The
    properties not passed will be left unchanged. A request without a
    `development` property will leave the development branch unchanged.
    
    The `production` branch can be a specific branch, the main
    branch or disabled. Any branch name can be supplied, but will only
    successfully be applied to a repository via inheritance if that branch
    exists for that repository. The `enabled` property can be used to enable (`true`)
    or disable (`false`) it. Only the passed properties will be updated. The
    properties not passed will be left unchanged. A request without a
    `production` property will leave the production branch unchanged.
    
    The `branch_types` property contains the branch types to be updated.
    Only the branch types passed will be updated. All updates will be
    rejected if it would leave the branching model in an invalid state.
    For branch types this means that:
    
    1. The prefixes for all enabled branch types are valid. For example,
       it is not possible to use '*' inside a Git prefix.
    2. A prefix of an enabled branch type must not be a prefix of another
       enabled branch type. This is to ensure that a branch can be easily
       classified by its prefix unambiguously.
    
    It is possible to store an invalid prefix if that branch type would be
    left disabled. Only the passed properties will be updated. The
    properties not passed will be left unchanged. Each branch type must
    have a `kind` property to identify it.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "branching_model_settings";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      branch_types?: readonly {
                          enabled?: (...) | (...) | (...);
                          kind:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          prefix?: (...) | (...);
                      }[];
                      development?: {
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      production?: {
                          enabled?: boolean;
                          is_valid?: boolean;
                          name?: string;
                          use_mainbranch?: boolean;
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "branching_model_settings";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    branch_types?: readonly {
                        enabled?: (...) | (...) | (...);
                        kind:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        prefix?: (...) | (...);
                    }[];
                    development?: {
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    production?: {
                        enabled?: boolean;
                        is_valid?: boolean;
                        name?: string;
                        use_mainbranch?: boolean;
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The updated branching model configuration

        • content: {
              application/json: {
                  type: "branching_model_settings";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  branch_types?: readonly {
                      enabled?: (...) | (...) | (...);
                      kind:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      prefix?: (...) | (...);
                  }[];
                  development?: {
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  production?: {
                      enabled?: boolean;
                      is_valid?: boolean;
                      name?: string;
                      use_mainbranch?: boolean;
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "branching_model_settings";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                branch_types?: readonly {
                    enabled?: (...) | (...) | (...);
                    kind:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    prefix?: (...) | (...);
                }[];
                development?: {
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                production?: {
                    enabled?: boolean;
                    is_valid?: boolean;
                    name?: string;
                    use_mainbranch?: boolean;
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request contains an invalid branching model configuration

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the request was not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/default-reviewers: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            reviewer_type?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            reviewer_type?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List the default reviewers in a project

    Return a list of all default reviewers for a project. This is a list of users that will be added as default reviewers to pull requests for any repository within the project.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          reviewer_type?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        reviewer_type?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The list of project default reviewers

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      reviewer_type?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    reviewer_type?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  reviewer_type?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the workspace or project does not exist at this location

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "user";
                    } & Omit<{
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        account_id?: string;
                        account_status?: string;
                        has_2fa_enabled?: boolean;
                        is_staff?: boolean;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        } & {
                            html?: (...) | (...);
                            repositories?: (...) | (...);
                            self?: (...) | (...);
                        };
                        nickname?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            selected_user: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "user";
                    } & Omit<{
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        account_id?: string;
                        account_status?: string;
                        has_2fa_enabled?: boolean;
                        is_staff?: boolean;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        } & {
                            html?: (...) | (...);
                            repositories?: (...) | (...);
                            self?: (...) | (...);
                        };
                        nickname?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Remove the specific user from the project's default reviewers

    Removes a default reviewer from the project.

    Example:
    ```
    $ curl https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D
    
    HTTP/1.1 204
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This can either be the actual key assigned to the project or the UUID (surrounded by curly-braces ({})).

        • Readonlyselected_user: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user was removed from the list of project default reviewers

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user is not a default reviewer for the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user, project, or workspace does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "user";
                    } & Omit<{
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        account_id?: string;
                        account_status?: string;
                        has_2fa_enabled?: boolean;
                        is_staff?: boolean;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        } & {
                            html?: (...) | (...);
                            repositories?: (...) | (...);
                            self?: (...) | (...);
                        };
                        nickname?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a default reviewer

    Returns the specified default reviewer.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This can either be the actual key assigned to the project or the UUID (surrounded by curly-braces ({})).

        • Readonlyselected_user: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "user";
                  } & Omit<{
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      account_id?: string;
                      account_status?: string;
                      has_2fa_enabled?: boolean;
                      is_staff?: boolean;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      } & {
                          html?: (...) | (...);
                          repositories?: (...) | (...);
                          self?: (...) | (...);
                      };
                      nickname?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "user";
                } & Omit<{
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    account_id?: string;
                    account_status?: string;
                    has_2fa_enabled?: boolean;
                    is_staff?: boolean;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    } & {
                        html?: (...) | (...);
                        repositories?: (...) | (...);
                        self?: (...) | (...);
                    };
                    nickname?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user that is a default reviewer

        • content: {
              application/json: {
                  type: "user";
              } & Omit<{
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  account_id?: string;
                  account_status?: string;
                  has_2fa_enabled?: boolean;
                  is_staff?: boolean;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  } & {
                      html?: (...) | (...);
                      repositories?: (...) | (...);
                      self?: (...) | (...);
                  };
                  nickname?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "user";
            } & Omit<{
                type: "account";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: (...) & (...);
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                account_id?: string;
                account_status?: string;
                has_2fa_enabled?: boolean;
                is_staff?: boolean;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                } & {
                    html?: (...) | (...);
                    repositories?: (...) | (...);
                    self?: (...) | (...);
                };
                nickname?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user is not a default reviewer for the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user, project, or workspace does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            selected_user: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          selected_user: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This can either be the actual key assigned to the project or the UUID (surrounded by curly-braces ({})).

      • Readonlyselected_user: string

        This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "user";
                    } & Omit<{
                        type: "account";
                    } & Omit<Readonly<(...)> & {
                        type: ...;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        created_on?: string;
                        display_name?: string;
                        links?: (...) & (...);
                        uuid?: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        account_id?: string;
                        account_status?: string;
                        has_2fa_enabled?: boolean;
                        is_staff?: boolean;
                        links?: Readonly<Record<(...), (...)>> & {
                            avatar?: (...) | (...);
                        } & {
                            html?: (...) | (...);
                            repositories?: (...) | (...);
                            self?: (...) | (...);
                        };
                        nickname?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Add the specific user as a default reviewer for the project

    Adds the specified user to the project's list of default reviewers. The method is idempotent. Accepts an optional body containing the uuid of the user to be added.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This can either be the actual key assigned to the project or the UUID (surrounded by curly-braces ({})).

        • Readonlyselected_user: string

          This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: {account UUID}.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "user";
                  } & Omit<{
                      type: "account";
                  } & Omit<Readonly<(...)> & {
                      type: ...;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      created_on?: string;
                      display_name?: string;
                      links?: (...) & (...);
                      uuid?: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      account_id?: string;
                      account_status?: string;
                      has_2fa_enabled?: boolean;
                      is_staff?: boolean;
                      links?: Readonly<Record<(...), (...)>> & {
                          avatar?: (...) | (...);
                      } & {
                          html?: (...) | (...);
                          repositories?: (...) | (...);
                          self?: (...) | (...);
                      };
                      nickname?: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "user";
                } & Omit<{
                    type: "account";
                } & Omit<Readonly<(...)> & {
                    type: ...;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    created_on?: string;
                    display_name?: string;
                    links?: (...) & (...);
                    uuid?: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    account_id?: string;
                    account_status?: string;
                    has_2fa_enabled?: boolean;
                    is_staff?: boolean;
                    links?: Readonly<Record<(...), (...)>> & {
                        avatar?: (...) | (...);
                    } & {
                        html?: (...) | (...);
                        repositories?: (...) | (...);
                        self?: (...) | (...);
                    };
                    nickname?: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The specified user was added as a project default reviewer

        • content: {
              application/json: {
                  type: "user";
              } & Omit<{
                  type: "account";
              } & Omit<Readonly<(...)> & {
                  type: ...;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  created_on?: string;
                  display_name?: string;
                  links?: (...) & (...);
                  uuid?: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  account_id?: string;
                  account_status?: string;
                  has_2fa_enabled?: boolean;
                  is_staff?: boolean;
                  links?: Readonly<Record<(...), (...)>> & {
                      avatar?: (...) | (...);
                  } & {
                      html?: (...) | (...);
                      repositories?: (...) | (...);
                      self?: (...) | (...);
                  };
                  nickname?: string;
              };
          }
          • Readonlyapplication/json: {
                type: "user";
            } & Omit<{
                type: "account";
            } & Omit<Readonly<(...)> & {
                type: ...;
            }, "type"> & Readonly<Record<string, unknown>> & {
                created_on?: string;
                display_name?: string;
                links?: (...) & (...);
                uuid?: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                account_id?: string;
                account_status?: string;
                has_2fa_enabled?: boolean;
                is_staff?: boolean;
                links?: Readonly<Record<(...), (...)>> & {
                    avatar?: (...) | (...);
                } & {
                    html?: (...) | (...);
                    repositories?: (...) | (...);
                    self?: (...) | (...);
                };
                nickname?: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user cannot be added as a default reviewer for the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the authenticated user does not have admin access to the project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user, project, or workspace does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/deploy-keys: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "project_deploy_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            added_on?: (...) | (...);
                            comment?: (...) | (...);
                            created_by?: (...) | (...);
                            key?: (...) | (...);
                            label?: (...) | (...);
                            last_used?: (...) | (...);
                            links?: (...) | (...);
                            project?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        created_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "project_deploy_key";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            added_on?: (...) | (...);
                            comment?: (...) | (...);
                            created_by?: (...) | (...);
                            key?: (...) | (...);
                            label?: (...) | (...);
                            last_used?: (...) | (...);
                            links?: (...) | (...);
                            project?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List project deploy keys

    Returns all deploy keys belonging to a project.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "project_deploy_key";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          added_on?: (...) | (...);
                          comment?: (...) | (...);
                          created_by?: (...) | (...);
                          key?: (...) | (...);
                          label?: (...) | (...);
                          last_used?: (...) | (...);
                          links?: (...) | (...);
                          project?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "project_deploy_key";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        added_on?: (...) | (...);
                        comment?: (...) | (...);
                        created_by?: (...) | (...);
                        key?: (...) | (...);
                        label?: (...) | (...);
                        last_used?: (...) | (...);
                        links?: (...) | (...);
                        project?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Deploy keys matching the project

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "project_deploy_key";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      added_on?: (...) | (...);
                      comment?: (...) | (...);
                      created_by?: (...) | (...);
                      key?: (...) | (...);
                      label?: (...) | (...);
                      last_used?: (...) | (...);
                      links?: (...) | (...);
                      project?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "project_deploy_key";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    added_on?: (...) | (...);
                    comment?: (...) | (...);
                    created_by?: (...) | (...);
                    key?: (...) | (...);
                    label?: (...) | (...);
                    last_used?: (...) | (...);
                    links?: (...) | (...);
                    project?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "project_deploy_key";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  added_on?: (...) | (...);
                  comment?: (...) | (...);
                  created_by?: (...) | (...);
                  key?: (...) | (...);
                  label?: (...) | (...);
                  last_used?: (...) | (...);
                  links?: (...) | (...);
                  project?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project is not accessible to the current user

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Readonlypost: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        created_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Create a project deploy key

    Create a new deploy key in a project.

    Example:
    ```
    $ curl -X POST \
    -H "Authorization <auth header>" \
    -H "Content-type: application/json" \
    https://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys/ -d \
    '{
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8",
        "label": "mydeploykey"
    }'
    ```
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "project_deploy_key";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      added_on?: string;
                      comment?: string;
                      created_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "project_deploy_key";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    added_on?: string;
                    comment?: string;
                    created_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The project deploy key that was created

        • content: {
              application/json: {
                  type: "project_deploy_key";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  added_on?: string;
                  comment?: string;
                  created_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "project_deploy_key";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                added_on?: string;
                comment?: string;
                created_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Invalid deploy key inputs

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project is not accessible to the current user

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        created_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete a deploy key from a project

    This deletes a deploy key from a project.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            project_key: string;
            workspace: string;
        }
        • Readonlykey_id: string

          The key ID matching the project deploy key.

        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The project deploy key has been deleted

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the current user does not have permission to delete a key for the specified project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace, project, or project deploy key does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                key_id: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "project_deploy_key";
                    } & Omit<Readonly<Record<string, unknown>> & {
                        type: string;
                    }, "type"> & Readonly<Record<string, unknown>> & {
                        added_on?: string;
                        comment?: string;
                        created_by?: {
                            type: "account";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            display_name?: (...) | (...);
                            links?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        key?: string;
                        label?: string;
                        last_used?: string;
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get a project deploy key

    Returns the deploy key belonging to a specific key ID.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              key_id: string;
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            key_id: string;
            project_key: string;
            workspace: string;
        }
        • Readonlykey_id: string

          The key ID matching the project deploy key.

        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      type: "project_deploy_key";
                  } & Omit<Readonly<Record<string, unknown>> & {
                      type: string;
                  }, "type"> & Readonly<Record<string, unknown>> & {
                      added_on?: string;
                      comment?: string;
                      created_by?: {
                          type: "account";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          display_name?: (...) | (...);
                          links?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      key?: string;
                      label?: string;
                      last_used?: string;
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    type: "project_deploy_key";
                } & Omit<Readonly<Record<string, unknown>> & {
                    type: string;
                }, "type"> & Readonly<Record<string, unknown>> & {
                    added_on?: string;
                    comment?: string;
                    created_by?: {
                        type: "account";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        display_name?: (...) | (...);
                        links?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    key?: string;
                    label?: string;
                    last_used?: string;
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Project deploy key matching the key ID

        • content: {
              application/json: {
                  type: "project_deploy_key";
              } & Omit<Readonly<Record<string, unknown>> & {
                  type: string;
              }, "type"> & Readonly<Record<string, unknown>> & {
                  added_on?: string;
                  comment?: string;
                  created_by?: {
                      type: "account";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      display_name?: (...) | (...);
                      links?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  key?: string;
                  label?: string;
                  last_used?: string;
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: {
                type: "project_deploy_key";
            } & Omit<Readonly<Record<string, unknown>> & {
                type: string;
            }, "type"> & Readonly<Record<string, unknown>> & {
                added_on?: string;
                comment?: string;
                created_by?: {
                    type: "account";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    display_name?: (...) | (...);
                    links?: (...) | (...);
                    uuid?: (...) | (...);
                };
                key?: string;
                label?: string;
                last_used?: string;
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project is not accessible to the current user

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified workspace or project does not exist

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            key_id: string;
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          key_id: string;
          project_key: string;
          workspace: string;
      }
      • Readonlykey_id: string

        The key ID matching the project deploy key.

      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            group?: (...) | (...);
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            project?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            group?: (...) | (...);
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            project?: (...) | (...);
                            type: string;
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List explicit group permissions for a project

    Returns a paginated list of explicit group permissions for the given project. This endpoint does not support BBQL features.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          group?: (...) | (...);
                          links?: (...) | (...);
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          project?: (...) | (...);
                          type: string;
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        group?: (...) | (...);
                        links?: (...) | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        project?: (...) | (...);
                        type: string;
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Paginated list of project group permissions

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      group?: (...) | (...);
                      links?: (...) | (...);
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      project?: (...) | (...);
                      type: string;
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    group?: (...) | (...);
                    links?: (...) | (...);
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    project?: (...) | (...);
                    type: string;
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  group?: (...) | (...);
                  links?: (...) | (...);
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  project?: (...) | (...);
                  type: string;
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user doesn't have admin access to the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or both of the workspace and project don't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            group_slug: string;
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an explicit group permission for a project

    Deletes the project group permission between the requested project and group, if one exists.

    Only users with admin permission for the project may access this resource.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            project_key: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The project group permission was deleted and no content returned.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the project, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and group doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an explicit group permission for a project

    Returns the group permission for a given group and project.

    Only users with admin permission for the project may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `create-repo`
    * `write`
    * `read`
    * `none`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            project_key: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      group?: {
                          type: "group";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          full_slug?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          slug?: (...) | (...);
                          workspace?: (...) | (...);
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "create-repo"
                          | "read"
                          | "write"
                          | "none";
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    group?: {
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write"
                        | "none";
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Project group permission

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  group?: {
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write"
                      | "none";
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                group?: {
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write"
                    | "none";
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user doesn't have admin access to the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and group doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            group_slug: string;
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          group_slug: string;
          project_key: string;
          workspace: string;
      }
      • Readonlygroup_slug: string

        Slug of the requested group.

      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                group_slug: string;
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        group?: {
                            type: "group";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            full_slug?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            slug?: (...) | (...);
                            workspace?: (...) | (...);
                        };
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an explicit group permission for a project

    Updates the group permission, or grants a new permission if one does not already exist.

    Only users with admin permission for the project may access this resource.
    
    Due to security concerns, the JWT and OAuth authentication methods are unsupported.
    This is to ensure integrations and add-ons are not allowed to change permissions.
    
    Permissions can be:
    
    * `admin`
    * `create-repo`
    * `write`
    * `read`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              group_slug: string;
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            group_slug: string;
            project_key: string;
            workspace: string;
        }
        • Readonlygroup_slug: string

          Slug of the requested group.

        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  permission:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write";
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                permission:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write";
            };
        }
        • Readonlyapplication/json: {
              permission:
                  | "admin"
                  | "create-repo"
                  | "read"
                  | "write";
          }
          • Readonlypermission:
                | "admin"
                | "create-repo"
                | "read"
                | "write"
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      group?: {
                          type: "group";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          full_slug?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          slug?: (...) | (...);
                          workspace?: (...) | (...);
                      };
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "create-repo"
                          | "read"
                          | "write"
                          | "none";
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          402: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    group?: {
                        type: "group";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        full_slug?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        slug?: (...) | (...);
                        workspace?: (...) | (...);
                    };
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write"
                        | "none";
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Project group permission updated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  group?: {
                      type: "group";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      full_slug?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      slug?: (...) | (...);
                      workspace?: (...) | (...);
                  };
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write"
                      | "none";
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                group?: {
                    type: "group";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    full_slug?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    slug?: (...) | (...);
                    workspace?: (...) | (...);
                };
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write"
                    | "none";
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No permission value was provided or the value is invalid(not one of read, write, create-repo, or admin).

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly402: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        You have reached your plan's user limit and must upgrade before giving access to additional users.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the project, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and group doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/permissions-config/users: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            project?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly (Readonly<Record<(...), (...)>> & {
                            links?: (...) | (...);
                            permission?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            project?: (...) | (...);
                            type: string;
                            user?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List explicit user permissions for a project

    Returns a paginated list of explicit user permissions for the given project. This endpoint does not support BBQL features.

    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly (Readonly<Record<(...), (...)>> & {
                          links?: (...) | (...);
                          permission?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          project?: (...) | (...);
                          type: string;
                          user?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly (Readonly<Record<(...), (...)>> & {
                        links?: (...) | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        project?: (...) | (...);
                        type: string;
                        user?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Paginated list of explicit user permissions.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly (Readonly<Record<(...), (...)>> & {
                      links?: (...) | (...);
                      permission?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      project?: (...) | (...);
                      type: string;
                      user?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly (Readonly<Record<(...), (...)>> & {
                    links?: (...) | (...);
                    permission?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    project?: (...) | (...);
                    type: string;
                    user?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly (Readonly<Record<(...), (...)>> & {
                  links?: (...) | (...);
                  permission?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  project?: (...) | (...);
                  type: string;
                  user?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user doesn't have admin access to the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or both of the workspace and project don't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            selected_user_id: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • Readonlydelete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Delete an explicit user permission for a project

    Deletes the project user permission between the requested project and user, if one exists.

    Only users with admin permission for the project may access this resource.
    
    Due to security concerns, the JWT and OAuth authentication methods are unsupported.
    This is to ensure integrations and add-ons are not allowed to change permissions.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyselected_user_id: string

          This can either be the username, the user's UUID surrounded by curly-braces, for example: {account UUID}, or the user's Atlassian ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          204: {
              content?: undefined;
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly204: {
            content?: undefined;
            headers: Readonly<Record<string, unknown>>;
        }

        The project user permission was deleted and no content returned.

        • Optionalcontent?: undefined
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the project, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and selected user doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Get an explicit user permission for a project

    Returns the explicit user permission for a given user and project.

    Only users with admin permission for the project may access this resource.
    
    Permissions can be:
    
    * `admin`
    * `create-repo`
    * `write`
    * `read`
    * `none`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyselected_user_id: string

          This can either be the username, the user's UUID surrounded by curly-braces, for example: {account UUID}, or the user's Atlassian ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "create-repo"
                          | "read"
                          | "write"
                          | "none";
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                      user?: {
                          type: "user";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          account_id?: (...) | (...);
                          account_status?: (...) | (...);
                          has_2fa_enabled?: (...) | (...) | (...);
                          is_staff?: (...) | (...) | (...);
                          links?: (...) | (...);
                          nickname?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write"
                        | "none";
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                    user?: {
                        type: "user";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        account_id?: (...) | (...);
                        account_status?: (...) | (...);
                        has_2fa_enabled?: (...) | (...) | (...);
                        is_staff?: (...) | (...) | (...);
                        links?: (...) | (...);
                        nickname?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Explicit user permission for user and project

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write"
                      | "none";
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
                  user?: {
                      type: "user";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      account_id?: (...) | (...);
                      account_status?: (...) | (...);
                      has_2fa_enabled?: (...) | (...) | (...);
                      is_staff?: (...) | (...) | (...);
                      links?: (...) | (...);
                      nickname?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write"
                    | "none";
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
                user?: {
                    type: "user";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    account_id?: (...) | (...);
                    account_status?: (...) | (...);
                    has_2fa_enabled?: (...) | (...) | (...);
                    is_staff?: (...) | (...) | (...);
                    links?: (...) | (...);
                    nickname?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the project.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and selected user doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            project_key: string;
            selected_user_id: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          project_key: string;
          selected_user_id: string;
          workspace: string;
      }
      • Readonlyproject_key: string

        The project in question. This is the actual key assigned to the project.

      • Readonlyselected_user_id: string

        This can either be the username, the user's UUID surrounded by curly-braces, for example: {account UUID}, or the user's Atlassian ID.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Readonlyput: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                project_key: string;
                selected_user_id: string;
                workspace: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    permission:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        links?: {
                            self?: {
                                href?: ...;
                                name?: ...;
                            };
                        };
                        permission?:
                            | "admin"
                            | "create-repo"
                            | "read"
                            | "write"
                            | "none";
                        project?: {
                            type: "project";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            created_on?: (...) | (...);
                            description?: (...) | (...);
                            has_publicly_visible_repos?: (...) | (...) | (...);
                            is_private?: (...) | (...) | (...);
                            key?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            owner?: (...) | (...);
                            updated_on?: (...) | (...);
                            uuid?: (...) | (...);
                        };
                        type: string;
                        user?: {
                            type: "user";
                        } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            account_id?: (...) | (...);
                            account_status?: (...) | (...);
                            has_2fa_enabled?: (...) | (...) | (...);
                            is_staff?: (...) | (...) | (...);
                            links?: (...) | (...);
                            nickname?: (...) | (...);
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            401: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            402: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            403: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Update an explicit user permission for a project

    Updates the explicit user permission for a given user and project. The selected user must be a member of the workspace, and cannot be the workspace owner.

    Only users with admin permission for the project may access this resource.
    
    Due to security concerns, the JWT and OAuth authentication methods are unsupported.
    This is to ensure integrations and add-ons are not allowed to change permissions.
    
    Permissions can be:
    
    * `admin`
    * `create-repo`
    * `write`
    * `read`
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              project_key: string;
              selected_user_id: string;
              workspace: string;
          };
          query?: undefined;
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            project_key: string;
            selected_user_id: string;
            workspace: string;
        }
        • Readonlyproject_key: string

          The project in question. This is the actual key assigned to the project.

        • Readonlyselected_user_id: string

          This can either be the username, the user's UUID surrounded by curly-braces, for example: {account UUID}, or the user's Atlassian ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: undefined
    • ReadonlyrequestBody: {
          content: {
              application/json: {
                  permission:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write";
              };
          };
      }
      • Readonlycontent: {
            application/json: {
                permission:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write";
            };
        }
        • Readonlyapplication/json: {
              permission:
                  | "admin"
                  | "create-repo"
                  | "read"
                  | "write";
          }
          • Readonlypermission:
                | "admin"
                | "create-repo"
                | "read"
                | "write"
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      links?: {
                          self?: {
                              href?: ...;
                              name?: ...;
                          };
                      };
                      permission?:
                          | "admin"
                          | "create-repo"
                          | "read"
                          | "write"
                          | "none";
                      project?: {
                          type: "project";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          created_on?: (...) | (...);
                          description?: (...) | (...);
                          has_publicly_visible_repos?: (...) | (...) | (...);
                          is_private?: (...) | (...) | (...);
                          key?: (...) | (...);
                          links?: (...) | (...);
                          name?: (...) | (...);
                          owner?: (...) | (...);
                          updated_on?: (...) | (...);
                          uuid?: (...) | (...);
                      };
                      type: string;
                      user?: {
                          type: "user";
                      } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          account_id?: (...) | (...);
                          account_status?: (...) | (...);
                          has_2fa_enabled?: (...) | (...) | (...);
                          is_staff?: (...) | (...) | (...);
                          links?: (...) | (...);
                          nickname?: (...) | (...);
                      };
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          401: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          402: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          403: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    links?: {
                        self?: {
                            href?: ...;
                            name?: ...;
                        };
                    };
                    permission?:
                        | "admin"
                        | "create-repo"
                        | "read"
                        | "write"
                        | "none";
                    project?: {
                        type: "project";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        created_on?: (...) | (...);
                        description?: (...) | (...);
                        has_publicly_visible_repos?: (...) | (...) | (...);
                        is_private?: (...) | (...) | (...);
                        key?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        owner?: (...) | (...);
                        updated_on?: (...) | (...);
                        uuid?: (...) | (...);
                    };
                    type: string;
                    user?: {
                        type: "user";
                    } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        account_id?: (...) | (...);
                        account_status?: (...) | (...);
                        has_2fa_enabled?: (...) | (...) | (...);
                        is_staff?: (...) | (...) | (...);
                        links?: (...) | (...);
                        nickname?: (...) | (...);
                    };
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Explicit user permission updated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  links?: {
                      self?: {
                          href?: ...;
                          name?: ...;
                      };
                  };
                  permission?:
                      | "admin"
                      | "create-repo"
                      | "read"
                      | "write"
                      | "none";
                  project?: {
                      type: "project";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      created_on?: (...) | (...);
                      description?: (...) | (...);
                      has_publicly_visible_repos?: (...) | (...) | (...);
                      is_private?: (...) | (...) | (...);
                      key?: (...) | (...);
                      links?: (...) | (...);
                      name?: (...) | (...);
                      owner?: (...) | (...);
                      updated_on?: (...) | (...);
                      uuid?: (...) | (...);
                  };
                  type: string;
                  user?: {
                      type: "user";
                  } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      account_id?: (...) | (...);
                      account_status?: (...) | (...);
                      has_2fa_enabled?: (...) | (...) | (...);
                      is_staff?: (...) | (...) | (...);
                      links?: (...) | (...);
                      nickname?: (...) | (...);
                  };
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                links?: {
                    self?: {
                        href?: ...;
                        name?: ...;
                    };
                };
                permission?:
                    | "admin"
                    | "create-repo"
                    | "read"
                    | "write"
                    | "none";
                project?: {
                    type: "project";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    created_on?: (...) | (...);
                    description?: (...) | (...);
                    has_publicly_visible_repos?: (...) | (...) | (...);
                    is_private?: (...) | (...) | (...);
                    key?: (...) | (...);
                    links?: (...) | (...);
                    name?: (...) | (...);
                    owner?: (...) | (...);
                    updated_on?: (...) | (...);
                    uuid?: (...) | (...);
                };
                type: string;
                user?: {
                    type: "user";
                } & Omit<(...) & (...) & (...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    account_id?: (...) | (...);
                    account_status?: (...) | (...);
                    has_2fa_enabled?: (...) | (...) | (...);
                    is_staff?: (...) | (...) | (...);
                    links?: (...) | (...);
                    nickname?: (...) | (...);
                };
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        No permission value was provided or the value is invalid (not one of read, write, create-repo, or admin)

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly401: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The user couldn't be authenticated.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly402: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        You have reached your plan's user limit and must upgrade before giving access to additional users.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly403: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        The requesting user isn't an admin of the project, or the authentication method was not via app password.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        One or more of the workspace, project, and selected user doesn't exist for the given identifiers or the requesting user is not authenticated

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/pullrequests/{selected_user}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                workspace: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
            workspace: string;
        };
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                selected_user: string;
                workspace: string;
            };
            query?: {
                state?:
                    | "DECLINED"
                    | "MERGED"
                    | "OPEN"
                    | "SUPERSEDED";
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        size?: number;
                        values?: readonly ({
                            type: "pullrequest";
                        } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                            author?: (...) | (...);
                            close_source_branch?: (...) | (...) | (...);
                            closed_by?: (...) | (...);
                            comment_count?: (...) | (...);
                            created_on?: (...) | (...);
                            destination?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            merge_commit?: (...) | (...);
                            participants?: (...) | (...);
                            reason?: (...) | (...);
                            rendered?: (...) | (...);
                            reviewers?: (...) | (...);
                            source?: (...) | (...);
                            state?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            summary?: (...) | (...);
                            task_count?: (...) | (...);
                            title?: (...) | (...);
                            updated_on?: (...) | (...);
                        })[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    List workspace pull requests for a user

    Returns all workspace pull requests authored by the specified user.

    By default only open pull requests are returned. This can be controlled
    using the `state` query parameter. To retrieve pull requests that are
    in one of multiple states, repeat the `state` parameter for each
    individual state.
    
    This endpoint also supports filtering and sorting of the results. See
    [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              selected_user: string;
              workspace: string;
          };
          query?: {
              state?:
                  | "DECLINED"
                  | "MERGED"
                  | "OPEN"
                  | "SUPERSEDED";
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            selected_user: string;
            workspace: string;
        }
        • Readonlyselected_user: string

          This can either be the username of the pull request author, the author's UUID surrounded by curly-braces, for example: {account UUID}, or the author's Atlassian ID.

        • Readonlyworkspace: string

          This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

      • Optional Readonlyquery?: {
            state?:
                | "DECLINED"
                | "MERGED"
                | "OPEN"
                | "SUPERSEDED";
        }
        • Optional Readonlystate?:
              | "DECLINED"
              | "MERGED"
              | "OPEN"
              | "SUPERSEDED"

          Only return pull requests that are in this state. This parameter can be repeated.

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      size?: number;
                      values?: readonly ({
                          type: "pullrequest";
                      } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                          author?: (...) | (...);
                          close_source_branch?: (...) | (...) | (...);
                          closed_by?: (...) | (...);
                          comment_count?: (...) | (...);
                          created_on?: (...) | (...);
                          destination?: (...) | (...);
                          id?: (...) | (...);
                          links?: (...) | (...);
                          merge_commit?: (...) | (...);
                          participants?: (...) | (...);
                          reason?: (...) | (...);
                          rendered?: (...) | (...);
                          reviewers?: (...) | (...);
                          source?: (...) | (...);
                          state?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          summary?: (...) | (...);
                          task_count?: (...) | (...);
                          title?: (...) | (...);
                          updated_on?: (...) | (...);
                      })[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    size?: number;
                    values?: readonly ({
                        type: "pullrequest";
                    } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                        author?: (...) | (...);
                        close_source_branch?: (...) | (...) | (...);
                        closed_by?: (...) | (...);
                        comment_count?: (...) | (...);
                        created_on?: (...) | (...);
                        destination?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        merge_commit?: (...) | (...);
                        participants?: (...) | (...);
                        reason?: (...) | (...);
                        rendered?: (...) | (...);
                        reviewers?: (...) | (...);
                        source?: (...) | (...);
                        state?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        summary?: (...) | (...);
                        task_count?: (...) | (...);
                        title?: (...) | (...);
                        updated_on?: (...) | (...);
                    })[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        All pull requests authored by the specified user.

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  size?: number;
                  values?: readonly ({
                      type: "pullrequest";
                  } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                      author?: (...) | (...);
                      close_source_branch?: (...) | (...) | (...);
                      closed_by?: (...) | (...);
                      comment_count?: (...) | (...);
                      created_on?: (...) | (...);
                      destination?: (...) | (...);
                      id?: (...) | (...);
                      links?: (...) | (...);
                      merge_commit?: (...) | (...);
                      participants?: (...) | (...);
                      reason?: (...) | (...);
                      rendered?: (...) | (...);
                      reviewers?: (...) | (...);
                      source?: (...) | (...);
                      state?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      summary?: (...) | (...);
                      task_count?: (...) | (...);
                      title?: (...) | (...);
                      updated_on?: (...) | (...);
                  })[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                size?: number;
                values?: readonly ({
                    type: "pullrequest";
                } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                    author?: (...) | (...);
                    close_source_branch?: (...) | (...) | (...);
                    closed_by?: (...) | (...);
                    comment_count?: (...) | (...);
                    created_on?: (...) | (...);
                    destination?: (...) | (...);
                    id?: (...) | (...);
                    links?: (...) | (...);
                    merge_commit?: (...) | (...);
                    participants?: (...) | (...);
                    reason?: (...) | (...);
                    rendered?: (...) | (...);
                    reviewers?: (...) | (...);
                    source?: (...) | (...);
                    state?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    summary?: (...) | (...);
                    task_count?: (...) | (...);
                    title?: (...) | (...);
                    updated_on?: (...) | (...);
                })[];
            }
            • Optional Readonlynext?: string

              Format: uri

              Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlypage?: number

              Page number of the current results. This is an optional element that is not provided in all responses.

            • Optional Readonlypagelen?: number

              Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

            • Optional Readonlyprevious?: string

              Format: uri

              Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

            • Optional Readonlysize?: number

              Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

            • Optional Readonlyvalues?: readonly ({
                  type: "pullrequest";
              } & Omit<(...) & (...), "type"> & Readonly<Record<(...), (...)>> & {
                  author?: (...) | (...);
                  close_source_branch?: (...) | (...) | (...);
                  closed_by?: (...) | (...);
                  comment_count?: (...) | (...);
                  created_on?: (...) | (...);
                  destination?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  merge_commit?: (...) | (...);
                  participants?: (...) | (...);
                  reason?: (...) | (...);
                  rendered?: (...) | (...);
                  reviewers?: (...) | (...);
                  source?: (...) | (...);
                  state?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  summary?: (...) | (...);
                  task_count?: (...) | (...);
                  title?: (...) | (...);
                  updated_on?: (...) | (...);
              })[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the specified user does not exist.

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path: {
            selected_user: string;
            workspace: string;
        };
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Readonlypath: {
          selected_user: string;
          workspace: string;
      }
      • Readonlyselected_user: string

        This can either be the username of the pull request author, the author's UUID surrounded by curly-braces, for example: {account UUID}, or the author's Atlassian ID.

      • Readonlyworkspace: string

        This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined
/workspaces/{workspace}/search/code: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<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

  • Optional Readonlydelete?: undefined
  • Readonlyget: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                workspace: string;
            };
            query: {
                page?: number;
                pagelen?: number;
                search_query: string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        next?: string;
                        page?: number;
                        pagelen?: number;
                        previous?: string;
                        query_substituted?: boolean;
                        size?: number;
                        values?: readonly {
                            content_match_count?: number;
                            content_matches?: readonly (...)[];
                            file?: (...) & (...);
                            path_matches?: readonly (...)[];
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            400: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            404: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            429: {
                content: {
                    application/json: Readonly<Record<string, unknown>> & {
                        error?: {
                            data?: Readonly<(...)>;
                            detail?: string;
                            message: string;
                        };
                        type: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    }

    Search for code in a workspace

    Search for code in the repositories of the specified workspace.

    Note that searches can match in the file's text (`content_matches`),
    the path (`path_matches`), or both.
    
    You can use the same syntax for the search query as in the UI.
    E.g. to search for "foo" only within the repository "demo",
    use the query parameter `search_query=foo+repo:demo`.
    
    Similar to other APIs, you can request more fields using a
    `fields` query parameter. E.g. to get some more information about
    the repository of matched files, use the query parameter
    `search_query=foo&fields=%2Bvalues.file.commit.repository`
    (the `%2B` is a URL-encoded `+`).
    
    Try `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.
    
    • Readonlyparameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              workspace: string;
          };
          query: {
              page?: number;
              pagelen?: number;
              search_query: string;
          };
      }
      • Optional Readonlycookie?: undefined
      • Optional Readonlyheader?: undefined
      • Readonlypath: {
            workspace: string;
        }
        • Readonlyworkspace: string

          The workspace to search in; either the slug or the UUID in curly braces

      • Readonlyquery: {
            page?: number;
            pagelen?: number;
            search_query: string;
        }
        • Optional Readonlypage?: number

          Which page of the search results to retrieve

        • Optional Readonlypagelen?: number

          How many search results to retrieve per page

        • Readonlysearch_query: string

          The search query

    • Optional ReadonlyrequestBody?: undefined
    • Readonlyresponses: {
          200: {
              content: {
                  application/json: {
                      next?: string;
                      page?: number;
                      pagelen?: number;
                      previous?: string;
                      query_substituted?: boolean;
                      size?: number;
                      values?: readonly {
                          content_match_count?: number;
                          content_matches?: readonly (...)[];
                          file?: (...) & (...);
                          path_matches?: readonly (...)[];
                          type?: string;
                      }[];
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          400: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          404: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
          429: {
              content: {
                  application/json: Readonly<Record<string, unknown>> & {
                      error?: {
                          data?: Readonly<(...)>;
                          detail?: string;
                          message: string;
                      };
                      type: string;
                  };
              };
              headers: Readonly<Record<string, unknown>>;
          };
      }
      • Readonly200: {
            content: {
                application/json: {
                    next?: string;
                    page?: number;
                    pagelen?: number;
                    previous?: string;
                    query_substituted?: boolean;
                    size?: number;
                    values?: readonly {
                        content_match_count?: number;
                        content_matches?: readonly (...)[];
                        file?: (...) & (...);
                        path_matches?: readonly (...)[];
                        type?: string;
                    }[];
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Successful search

        • content: {
              application/json: {
                  next?: string;
                  page?: number;
                  pagelen?: number;
                  previous?: string;
                  query_substituted?: boolean;
                  size?: number;
                  values?: readonly {
                      content_match_count?: number;
                      content_matches?: readonly (...)[];
                      file?: (...) & (...);
                      path_matches?: readonly (...)[];
                      type?: string;
                  }[];
              };
          }
          • Readonlyapplication/json: {
                next?: string;
                page?: number;
                pagelen?: number;
                previous?: string;
                query_substituted?: boolean;
                size?: number;
                values?: readonly {
                    content_match_count?: number;
                    content_matches?: readonly (...)[];
                    file?: (...) & (...);
                    path_matches?: readonly (...)[];
                    type?: string;
                }[];
            }
            • Optional Readonlynext?: string

              Format: uri

            • Optional Readonlypage?: number

              Format: int32

            • Optional Readonlypagelen?: number

              Format: int32

            • Optional Readonlyprevious?: string

              Format: uri

            • Optional Readonlyquery_substituted?: boolean
            • Optional Readonlysize?: number

              Format: int64

            • Optional Readonlyvalues?: readonly {
                  content_match_count?: number;
                  content_matches?: readonly (...)[];
                  file?: (...) & (...);
                  path_matches?: readonly (...)[];
                  type?: string;
              }[]
        • headers: Readonly<Record<string, unknown>>
      • Readonly400: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        If the search request was invalid due to one of the following reasons:

        * the specified type of target account doesn''t match the actual
        account type;
        
        * malformed pagination properties;
        
        * missing or malformed search query, in the latter case an error
        key will be returned in `error.data.key` property.
        
        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly404: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Search is not enabled for the requested workspace, navigate to https://bitbucket.org/search to turn it on

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
      • Readonly429: {
            content: {
                application/json: Readonly<Record<string, unknown>> & {
                    error?: {
                        data?: Readonly<(...)>;
                        detail?: string;
                        message: string;
                    };
                    type: string;
                };
            };
            headers: Readonly<Record<string, unknown>>;
        }

        Too many requests, try again later

        • content: {
              application/json: Readonly<Record<string, unknown>> & {
                  error?: {
                      data?: Readonly<(...)>;
                      detail?: string;
                      message: string;
                  };
                  type: string;
              };
          }
          • Readonlyapplication/json: Readonly<Record<string, unknown>> & {
                error?: {
                    data?: Readonly<(...)>;
                    detail?: string;
                    message: string;
                };
                type: string;
            }
        • headers: Readonly<Record<string, unknown>>
  • Optional Readonlyhead?: undefined
  • Optional Readonlyoptions?: undefined
  • Readonlyparameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optional Readonlycookie?: undefined
    • Optional Readonlyheader?: undefined
    • Optional Readonlypath?: undefined
    • Optional Readonlyquery?: undefined
  • Optional Readonlypatch?: undefined
  • Optional Readonlypost?: undefined
  • Optional Readonlyput?: undefined
  • Optional Readonlytrace?: undefined